ChargeAfter Checkout API
The Checkout API from ChargeAfter — 2 operation(s) for checkout.
OpenAPI Specification
openapi: 3.2.0
info:
title: Distribution Checkout API
description: Welcome to ChargeAfter API reference! This API is implemented in a RESTful state of mind, it has straight-forward, resource-oriented endpoints, and produces standard HTTP response codes to communicate back the result of operations. To get started please contact ChargeAfter support to get your API keys, and get an access to your testing and live environments.
termsOfService: https://chargeafter.com/privacy-policy
contact:
name: Customer Support
email: support@chargeafter.com
version: 0.0.5+bf6238465dcb01cfc82360350426730cb9363c90
servers:
- url: https://api-sandbox.ca-dev.co
description: Local Environment
- url: https://api.chargeafter.com
description: Production Environment
security:
- apiKey: []
tags:
- name: Checkout
paths:
/v2/checkout/accounts:
post:
tags:
- Checkout
summary: Get accounts with offers for consumer
description: Looks up an existing account and returns relevant offers. If there is no existing account, this creates a new account and returns relevant offers.
parameters:
- name: lookupOnly
in: query
description: Optional flag to indicate that only account lookup should be performed. If TRUE, then if there is no existing account, a new account will not be created.
schema:
type: boolean
requestBody:
content:
application/json-patch+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Requests.GetAccountsRequestBody'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Requests.GetAccountsRequestBody'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Requests.GetAccountsRequestBody'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Requests.GetAccountsRequestBody'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Responses.GetAccountsResponse'
examples:
Prequal:
summary: Prequal account response
value:
accountsInfo:
- id: 66fa53165e2c589770c401fc
lenderId: 66fa53165e2c589770c401fb
lenderName: Finara
lenderType: Unknown
status: PreApproved
usabilityStatus: Usable
offers:
- id: 165e2c589770c401fe
code: 53165e2c589770c401ff
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1200
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4214276Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c40200
code: 53165e2c589770c40201
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 2000
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4214351Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c40202
code: 53165e2c589770c40203
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1500
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.421437Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
metadata: {}
isHighRisk: false
pendingSignature: false
lenderReturningConsumer: true
loanId: 66fa53165e2c589770c401fd
creditInfo:
availableCredit: 1500
maxAmount: 1500
failures: []
consumerId: 66fa53165e2c589770c40205
applicationId: 66fa53165e2c589770c40204
Approved:
summary: Approved account response
value:
accountsInfo:
- id: 66fa53165e2c589770c40207
lenderId: 66fa53165e2c589770c40206
lenderName: Finara
lenderType: Unknown
status: Approved
usabilityStatus: Usable
offers:
- id: 165e2c589770c40209
code: 53165e2c589770c4020a
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1200
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218391Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c4020b
code: 53165e2c589770c4020c
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 2000
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218424Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c4020d
code: 53165e2c589770c4020e
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1500
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218451Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
metadata: {}
isHighRisk: false
pendingSignature: false
lenderReturningConsumer: true
loanId: 66fa53165e2c589770c40208
creditInfo:
availableCredit: 1500
maxAmount: 1500
failures: []
consumerId: 66fa53165e2c589770c40210
applicationId: 66fa53165e2c589770c4020f
Declined:
summary: Declined account response
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40213
lenderName: Finara
status: Declined
errors: []
ineligibility: null
disclosures:
decline:
type: Hosted
url: null
mimeType: null
consumerId: 66fa53165e2c589770c40212
applicationId: 66fa53165e2c589770c40211
ErrorAuthentication:
summary: No account, authentication required
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40216
lenderName: Finara
status: Error
errors:
- code: '1260'
description: Authentication required
metadata: null
ineligibility: null
disclosures: null
consumerId: 66fa53165e2c589770c40215
applicationId: 66fa53165e2c589770c40214
ErrorLender:
summary: No account, unknown lender error
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40219
lenderName: Finara
status: Error
errors:
- code: '1000'
description: Unknown error occurred
metadata: null
ineligibility: null
disclosures: null
consumerId: 66fa53165e2c589770c40218
applicationId: 66fa53165e2c589770c40217
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Responses.GetAccountsResponse'
examples:
Prequal:
summary: Prequal account response
value:
accountsInfo:
- id: 66fa53165e2c589770c401fc
lenderId: 66fa53165e2c589770c401fb
lenderName: Finara
lenderType: Unknown
status: PreApproved
usabilityStatus: Usable
offers:
- id: 165e2c589770c401fe
code: 53165e2c589770c401ff
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1200
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4214276Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c40200
code: 53165e2c589770c40201
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 2000
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4214351Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c40202
code: 53165e2c589770c40203
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1500
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.421437Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
metadata: {}
isHighRisk: false
pendingSignature: false
lenderReturningConsumer: true
loanId: 66fa53165e2c589770c401fd
creditInfo:
availableCredit: 1500
maxAmount: 1500
failures: []
consumerId: 66fa53165e2c589770c40205
applicationId: 66fa53165e2c589770c40204
Approved:
summary: Approved account response
value:
accountsInfo:
- id: 66fa53165e2c589770c40207
lenderId: 66fa53165e2c589770c40206
lenderName: Finara
lenderType: Unknown
status: Approved
usabilityStatus: Usable
offers:
- id: 165e2c589770c40209
code: 53165e2c589770c4020a
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1200
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218391Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c4020b
code: 53165e2c589770c4020c
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 2000
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218424Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
- id: 165e2c589770c4020d
code: 53165e2c589770c4020e
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1500
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4218451Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
eligibility:
status: Eligible
ineligibilityReason: null
tags: {}
disclosures:
apply:
type: Hosted
url: null
mimeType: null
confirm:
type: Link
url: http://test
mimeType: html
metadata: {}
isHighRisk: false
pendingSignature: false
lenderReturningConsumer: true
loanId: 66fa53165e2c589770c40208
creditInfo:
availableCredit: 1500
maxAmount: 1500
failures: []
consumerId: 66fa53165e2c589770c40210
applicationId: 66fa53165e2c589770c4020f
Declined:
summary: Declined account response
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40213
lenderName: Finara
status: Declined
errors: []
ineligibility: null
disclosures:
decline:
type: Hosted
url: null
mimeType: null
consumerId: 66fa53165e2c589770c40212
applicationId: 66fa53165e2c589770c40211
ErrorAuthentication:
summary: No account, authentication required
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40216
lenderName: Finara
status: Error
errors:
- code: '1260'
description: Authentication required
metadata: null
ineligibility: null
disclosures: null
consumerId: 66fa53165e2c589770c40215
applicationId: 66fa53165e2c589770c40214
ErrorLender:
summary: No account, unknown lender error
value:
accountsInfo: []
failures:
- lenderId: 66fa53165e2c589770c40219
lenderName: Finara
status: Error
errors:
- code: '1000'
description: Unknown error occurred
metadata: null
ineligibility: null
disclosures: null
consumerId: 66fa53165e2c589770c40218
applicationId: 66fa53165e2c589770c40217
text/json:
schema:
$ref: '#/components/schemas/ChargeAfter.Distribution.WebApi.Contracts.Responses.GetAccountsResponse'
examples:
Prequal:
summary: Prequal account response
value:
accountsInfo:
- id: 66fa53165e2c589770c401fc
lenderId: 66fa53165e2c589770c401fb
lenderName: Finara
lenderType: Unknown
status: PreApproved
usabilityStatus: Usable
offers:
- id: 165e2c589770c401fe
code: 53165e2c589770c401ff
defaultCode: null
financialProductType: LineOfCredit
defaultAPR: 13.99
amount: 1200
promoSettings:
isPromo: true
period: null
numberOfPeriods: 6
periodicPayment: 500
periodType: Month
apr: 13.99
type: null
metadata: {}
lateFeeAmountTierOne: null
annualFeeAmount: 0
dailyPeriodicRate: 0
lateFeeMinimumAmount: null
minFinanceCharge: null
returnedPaymentFeeAmount: null
minimumPaymentDue: null
expirationDate: '2024-10-30T07:28:22.4214276Z'
checkoutMinimumAmount: 300
description: No Interest if Paid in Full in 6 Months
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chargeafter/refs/heads/main/openapi/chargeafter-checkout-api-openapi.yml