---
agentTools:
projectIndex: https://docs.chargeafter.com/llms.txt
---
# Get accounts by consumerId
Lookup existing accounts by consumerId
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Consumer 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": "1.0.0"
},
"paths": {
"/v2/consumers/{consumerId}/accounts": {
"get": {
"tags": [
"ConsumersV2"
],
"summary": "Get accounts by consumerId",
"description": "Lookup existing accounts by consumerId",
"parameters": [
{
"name": "consumerId",
"in": "path",
"description": "Unique identifier of the consumer.",
"required": true,
"schema": {
"type": "string",
"example": "lm9u5be2c2bkjeejj01bmfm3"
},
"example": "lm9u5be2c2bkjeejj01bmfm3"
},
{
"name": "channel",
"in": "query",
"description": "The channel of the original purchase.
If not provided, the E_COMMERCE channel will be used.
\r\nOther options are IN_STORE / CALL_CENTER / IN_HOME
",
"schema": {
"type": "string",
"example": "E_COMMERCE"
},
"example": "E_COMMERCE"
},
{
"name": "storeId",
"in": "query",
"description": "The store identifier.",
"schema": {
"type": "string",
"example": "123W"
},
"example": "123W"
},
{
"name": "posId",
"in": "query",
"description": "The point of sale identifier.",
"schema": {
"type": "string"
}
},
{
"name": "posType",
"in": "query",
"description": "The point of sale type.",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.PosType"
}
]
}
},
{
"name": "currency",
"in": "query",
"description": "Optional ISO 4217 currency code. If not provided, the USD currency will be used.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Request is successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChargeAfter.ConsumersV1.WebApi.Contracts.Responses.LookupAccountsResponse"
}
}
}
},
"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": "Consumer is not found or the user is unauthorized to request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChargeAfter.Libraries.ErrorHandling.Exceptions.V1ApiError"
}
}
}
},
"422": {
"description": "Server unable to process request because it contains invalid data",
"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": {
"example": {
"requestId": "Unique RequestId",
"errors": [
{
"code": "1",
"description": "Internal unknown error occurred"
}
]
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ChargeAfter.ConsumersV1.WebApi.Contracts.Models.AccountInfo": {
"required": [
"account"
],
"type": "object",
"properties": {
"account": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Account"
}
],
"description": "Consumer account as returned by the configured lender"
},
"accountToken": {
"type": "string",
"description": "Account token used for confirmation/charge creation. Returned for approved account",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.ConsumersV1.WebApi.Contracts.Models.Failure": {
"required": [
"lenderId",
"lenderName"
],
"type": "object",
"properties": {
"lenderId": {
"minLength": 1,
"type": "string",
"description": "Unique identifier of the lender."
},
"lenderName": {
"minLength": 1,
"type": "string",
"description": "Lender display name.
Note: Because this value may change, customers should not bind to this parameter. Instead, bind to the lenderId and set the lenderName in your system."
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FailureStatus"
}
],
"description": "Failure status"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Error"
},
"description": "Failure errors, provided if status is Error",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.ConsumersV1.WebApi.Contracts.Responses.LookupAccountsResponse": {
"required": [
"applicationId"
],
"type": "object",
"properties": {
"accountsInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeAfter.ConsumersV1.WebApi.Contracts.Models.AccountInfo"
},
"description": "Consumer accounts with additional information",
"nullable": true
},
"applicationId": {
"minLength": 1,
"type": "string",
"description": "Unique identifier of the application"
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeAfter.ConsumersV1.WebApi.Contracts.Models.Failure"
},
"description": "List of failed lookups and unusable accounts",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Contracts.AccountStatus": {
"enum": [
"None",
"New",
"NotFound",
"PreApproved",
"Approved",
"Banned",
"Declined",
"Error",
"Pending",
"PartiallyApproved",
"Frozen",
"PreDeclined",
"PendingConsumer",
"Cancelled"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.AccountStatusReason": {
"enum": [
"ApplicationNotCompleted",
"MissingStips",
"MissingESign",
"MissingConfirmation",
"MissingStipsVerification",
"MissingStipsReview",
"LoanAlreadyUsed",
"NoCreditAvailable",
"FailedCardValidation",
"CardValidationExpired"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.ApplicationStatusReason": {
"enum": [
"ConsumerApplicationNotCompleted",
"AccountFrozen",
"ConsumerBanned",
"MissingESign",
"PendingLenderDocumentReview",
"Error",
"PendingCallLenderToResolve",
"PendingUploadDocumentToResolve"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.ConsumerApplicationStatus": {
"enum": [
"New",
"Prequalified",
"CheckoutInProgress",
"PendingConsumer",
"PendingLender",
"PendingMerchant",
"Approved",
"Authorized",
"Declined",
"Expired",
"Cancelled"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.LenderAccountStatus": {
"enum": [
"Inactive",
"PendingConsumer",
"PendingLender",
"PendingMerchant",
"Active"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.PeriodType": {
"enum": [
"Day",
"Month",
"Week",
"BiWeek"
],
"type": "string"
},
"ChargeAfter.Libraries.Entities.PosType": {
"enum": [
"Kiosk",
"Retail",
"GenericMerchantDevice",
"GenericConsumerDevice",
"SelfServiceTerminal"
],
"type": "string"
},
"ChargeAfter.Libraries.ErrorHandling.Exceptions.V1ApiError": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Account": {
"required": [
"id",
"lenderId",
"lenderName",
"offers",
"status"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"lenderId": {
"minLength": 1,
"type": "string"
},
"lenderName": {
"minLength": 1,
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Contracts.AccountStatus"
}
]
},
"offers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Offer"
}
},
"creditInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.CreditInfo"
}
],
"nullable": true
},
"applicationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.ConsumerApplicationStatus"
}
],
"nullable": true
},
"applicationStatusReason": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.ApplicationStatusReason"
}
],
"nullable": true
},
"accountStatus": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.LenderAccountStatus"
}
],
"nullable": true
},
"accountStatusReason": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.AccountStatusReason"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.ApplicationType": {
"enum": [
"Unknown",
"New",
"Prequalification",
"Application",
"Error"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.CreditInfo": {
"type": "object",
"properties": {
"availableCredit": {
"type": "number",
"format": "double"
},
"maxAmount": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Disclosure": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.DisclosureType"
}
]
},
"url": {
"type": "string",
"nullable": true
},
"mimeType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.DisclosureType": {
"enum": [
"Link",
"Hosted",
"Template"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Eligibility": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.EligibilityStatus"
}
]
},
"ineligibilityReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.EligibilityStatus": {
"enum": [
"Eligible",
"Ineligible"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"additionalProperties": {},
"nullable": true
},
"applicationType": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.ApplicationType"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FailureStatus": {
"enum": [
"None",
"NotFound",
"PreApproved",
"Approved",
"Banned",
"Declined",
"NonUsable",
"Error",
"Pending",
"Ineligible",
"Cancelled"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FinancialProductType": {
"enum": [
"LineOfCredit",
"Installments",
"LeaseToOwn",
"MerchantSelfFinancing"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Offer": {
"required": [
"amount",
"code",
"defaultAPR",
"financialProductType"
],
"type": "object",
"properties": {
"code": {
"minLength": 1,
"type": "string"
},
"financialProductType": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FinancialProductType"
}
]
},
"defaultAPR": {
"type": "number",
"format": "double"
},
"amount": {
"type": "number",
"format": "double"
},
"promoSettings": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.PromoSettings"
}
],
"nullable": true
},
"metadata": {
"type": "object",
"additionalProperties": {},
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkoutMinimumAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"eligibility": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Eligibility"
}
],
"nullable": true
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"disclosures": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.OfferDisclosures"
}
],
"nullable": true
},
"offerType": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.OfferType"
}
]
},
"texts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.OfferDisclosures": {
"type": "object",
"properties": {
"apply": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Disclosure"
}
],
"nullable": true
},
"confirm": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.Disclosure"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.OfferType": {
"enum": [
"Regular",
"Sample"
],
"type": "string"
},
"ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.PromoSettings": {
"type": "object",
"properties": {
"isPromo": {
"type": "boolean"
},
"numberOfPeriods": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodicPayment": {
"type": "number",
"format": "double",
"nullable": true
},
"periodType": {
"allOf": [
{
"$ref": "#/components/schemas/ChargeAfter.Libraries.Entities.PeriodType"
}
],
"nullable": true
},
"apr": {
"type": "number",
"format": "double",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"description": "ChargeAfter API supports an API key based authentication, provided in the `apiKey` HTTP header.",
"name": "Authorization",
"in": "header"
}
}
},
"servers": [
{
"url": "https://api-sandbox.ca-dev.co",
"description": "Sandbox Environment"
},
{
"url": "https://api.chargeafter.com",
"description": "Production Environment"
}
],
"security": [
{
"apiKey": []
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 104,
"1": 137,
"2": 183,
"3": 167,
"4": 248,
"5": 65,
"6": 65,
"7": 217,
"8": 110,
"9": 199,
"10": 120,
"11": 198
}
}
}
```