Add a Card Account for a Recipient.
Response Codes
201- Created, will include a Location response header
200- Request Succeeded, but entity not created
400- Bad Request, missing or invalid parameters
404- Recipient ID not found
409- Conflict, card Account exists
422- Cannot process due to business constraints or fraud controls
PCI Compliance
Implementation of the Card Account endpoints require PCI compliance. If you are unsure of the requirements around PCI compliance, please contact [email protected] to discuss implementation options.
Card Eligibility
Currently, only Debit Visa and MasterCard accounts are eligible for
INSTANT_DEPOSITtransactions. Custom client configurations can support enabling or disabling Visa Credit cards or Prepaid Debit cards.
Card Account Uniquness
If the recipient has an active card account matching the card number and expiration date, a
409will be returned with the original card account response body.
Card Account Error Codes
Error codes specific to Card Accounts.
| Error Code | Details |
|---|---|
| ERR_ACCOUNT_SHARING_LIMIT_EXCEEDED | Card account matches active accounts under other Recipient(s) - the limit is configured on a per client basis |
| ERR_INVALID_CARD_DETAILS | Card BIN invalid or network detail not available from Visa |
| ERR_CARD_INELIGIBLE | Card network does not participate in Instant Deposit services |
| ERR_CREDIT_CARD_NOT_SUPPORTED | Credit card block is enabled |
| ERR_PREPAID_CARD_NOT_SUPPORTED | Prepaid card block is enabled |
| ERR_CARD_PAV_ERROR | Card Account Verification was unable complete due to system error. These requests can be retried. |
| ERR_CARD_PAV_PAN_FAILURE | Card Account Verification workflow - PAN (primary account number) is invalid |
| ERR_CARD_PAV_CVV_FAILURE | Card Account Verification workflow - CVV / Expiration Date combination is invalid |
Card Account Verification
Verification services are available when adding a Card Account via API or Create Card Widget. Our onboarding team will configure the verification services utilized. Details on how to trigger error scenarios in the Test Sandbox are documented on the Test Data page in the Test Values for Card Account Verification section.
- PAN (Primary account number) verification
- A PAN failure results in a
200with error codeERR_CARD_PAV_PAN_FAILURE
- A PAN failure results in a
- CVV / Expiration Date verification
- If the client account is configured for CVV verification and a CVV code is passed into the API request, the CVV / Expiration Date verification will be invoked. Card Widgets will include a CVV field if the client is configured for CVV verification.
- A CVV / Expiration Date failure results in a
200with error codeERR_CARD_PAV_CVV_FAILURE
- Address verification with street address and zip code (AVS)
- Address verification (AVS) uses the Recipient Address
- Account name verification (currently supported with Visa cards only)
- Name verification uses the Recipient's name
Verification details are provided with the Card Account response body in the verification_result object. The verification_result is also included in the Payment Account Webhook.
| Parameter | Possible Values | Result if no match |
|---|---|---|
| network | VISA / MASTERCARD | N/A - Informational |
| pan | MATCH / NO_MATCH | Card not added, error code in response |
| cvv | MATCH / NO_MATCH / NOT_PROCESSED / NOT_SUPPORTED | Card not added, error cod in response |
| avs.street | MATCH / NO_MATCH / NOT_PROCESSED / NOT_SUPPORTED | Card added, client can evaluate and delete account or allow account to remain active |
| avs.zip | MATCH / NO_MATCH / NOT_PROCESSED / NOT_SUPPORTED | Card added, client can evaluate and delete account or allow account to remain active |
| ani.first_name | MATCH / PARTIAL / NO_MATCH / NOT_PROCESSED / NOT_SUPPORTED | Card added, client can evaluate and delete account or allow account to remain active |
| ani.last_name | MATCH / PARTIAL / NO_MATCH / NOT_PROCESSED / NOT_SUPPORTED | Card added, client can evaluate and delete account or allow account to remain active |