ChargeAfter Accounts API
The Accounts API from ChargeAfter — 10 operation(s) for accounts.
OpenAPI Specification
openapi: 3.2.0
info:
title: Chargeafter Accounts API
contact:
name: Customer Support
email: support@chargeafter.com
termsOfService: https://chargeafter.com/privacy-policy
version: '1.0'
description: 'Operations tagged Accounts across 2 of this provider''s published API definitions: chargeafter-charge-api-openapi.yml, chargeafter-checkout-session-accounts-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
security:
- apiKey: []
tags:
- name: Accounts
paths:
/v2/accounts/charge:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
post:
tags:
- Accounts
summary: Create new charge with accountToken
description: Creates a new charge from an existing approved account with an accountToken.
parameters: []
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateChargeFromAccountRequestBody'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateChargeFromAccountRequestBody'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateChargeFromAccountRequestBody'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateChargeFromAccountRequestBody'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.ChargeCreationResponseDto'
'202':
description: Charge created, failed to settle
content:
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.ChargeCreationResponseDto'
'400':
description: Bad Request:<br/><ul><li><i>1110</i> - <validation error></li><li><i>2002</i> - charge already has assigned confirmation</li><li><i>2004</i> - confirmation not found</li></ul>
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1110'
description: <validation error>
- code: '2002'
description: charge already has assigned confirmation
- code: '2004'
description: confirmation not found
'401':
description: Unauthorized
'404':
description: Account not found
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
post:
tags:
- Accounts
summary: Create account
parameters: []
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountRequestBody'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountRequestBody'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountRequestBody'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountRequestBody'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateAccountResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'404':
description: Application not found
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/lookup/account-id:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
put:
tags:
- Accounts
summary: Lookup for account id by provided credit card details or account details.
parameters: []
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LookupByAccountIdRequestBody'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LookupByAccountIdRequestBody'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LookupByAccountIdRequestBody'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LookupByAccountIdRequestBody'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.ApplicationLookupResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.ApplicationLookupResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.ApplicationLookupResponse'
'400':
description: Bad Request:<br/><ul><li><i>1110</i> - <validation error></li></ul>
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1110'
description: <validation error>
'401':
description: Unauthorized
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/confirmation:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
post:
tags:
- Accounts
summary: Create confirmation with application and cart details
parameters: []
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationRequestBody'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationRequestBody'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationRequestBody'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationRequestBody'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreateConfirmationResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'404':
description: Application for credit card not found
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/{accountToken}/creditcard:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
get:
tags:
- Accounts
summary: Get information about credit card based on account id
parameters:
- name: accountToken
in: path
required: true
schema:
minLength: 1
type: string
- name: storeId
in: query
required: true
schema:
minLength: 1
type: string
- name: channel
in: query
required: true
schema:
minLength: 1
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditCardInfoResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditCardInfoResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditCardInfoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'404':
description: Confirmation not found
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/{accountToken}/credit:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
get:
tags:
- Accounts
summary: Get information about credit based on account id
parameters:
- name: accountToken
in: path
required: true
schema:
minLength: 1
type: string
- name: storeId
in: query
required: true
schema:
minLength: 1
type: string
- name: channel
in: query
required: true
schema:
minLength: 1
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditInfoResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditInfoResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.CreditInfoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/{accountToken}:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
get:
tags:
- Accounts
summary: Get information about account based on account id
parameters:
- name: accountToken
in: path
required: true
schema:
minLength: 1
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.AccountInfoResponse'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.AccountInfoResponse'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.AccountInfoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/lookup/lender/account-id:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
get:
tags:
- Accounts
summary: Get lender by personal account number
parameters:
- name: accountId
in: query
required: true
schema:
minLength: 1
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LenderDto'
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LenderDto'
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.LenderDto'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
properties:
requestId:
type: string
description: Associated request id
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error description
example:
requestId: Unique RequestId
errors:
- code: '1000'
description: Unknown error occurred
/v2/accounts/deprecate:
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
patch:
tags:
- Accounts
summary: Deprecate account based on lender loan id
parameters: []
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.PostsaleAdapter.WebApi.Contracts.DeprecateAccountRequestBody'
application/json:
schema:
allOf:
- $ref: '#/compo
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chargeafter/refs/heads/main/openapi/chargeafter-accounts-api-openapi.yml