POST///
Adds a new external card for use in fund transfers.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the external card. Allowable Values: Valid external card token |
| pan string Required | Primary account number (PAN) of the external card. Allowable Values: 13–19 chars |
| cvv string Required | Card verification value (CVV2) of the external card. Allowable Values: Valid CVV2 |
| expiration string Required | Expiration date of the external card. Allowable Values: Format: MMyy |
| require_push_funds_eligibility boolean Optional | A value of true indicates that the external card is eligible to push funds. The request will fail if it is ineligible. The default value of this field is false.Allowable Values: true, false |
| require_pull_funds_eligibility boolean Optional | A value of true indicates that the external card is eligible to pull funds. The request will fail if it is ineligible. The default value of this field is false.Allowable Values: true, false |
| billing_details object Required | Billing details. Note: You must include either first_name and last_name, or business_name.Allowable Values: Valid billing details object |
| billing_details.first_name string Optional | First name or given name of the external account holder. Allowable Values: 40 char max |
| billing_details.middle_name string Optional | Middle name of the external account holder. Allowable Values: 40 char max |
| billing_details.last_name string Optional | Last or family name of the external account holder. Allowable Values: 40 char max |
| billing_details.business_name string Optional | Business name of the external account holder. Allowable Values: 40 char max |
| billing_details.address_1 string Required | Street name and number of the external account holder’s address. Allowable Values: 255 char max |
| billing_details.address_2 string Optional | Additional external account holder address information. Allowable Values: 255 char max |
| billing_details.city string Required | City of the external account holder’s address. Allowable Values: 40 char max |
| billing_details.country_subdivision string Required | Two-character state, province, or territorial abbreviation. For a complete list of valid abbreviations, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 chars |
| billing_details.postal_code string Required | Postal code of the external account holder’s address. Allowable Values: 20 char max |
| billing_details.country string Required | Country of the external account holder’s address in a valid alpha-3 ISO 3166 country code. Allowable Values: 3 chars |
| user_token string Optional | Unique identifier of the user resource. Allowable Values: Valid user token |
| business_token string Optional | Unique identifier of the business resource. Allowable Values: Valid business token |
Sample request body
Add external card for a userJSON
{
"token": "ext_card_12345",
"pan": "4111111111111111",
"cvv": "123",
"expiration": "1230",
"user_token": "user_67890",
"billing_details": {
"first_name": "Jane",
"last_name": "Doe",
"address_1": "123 Main Street",
"city": "Oakland",
"country_subdivision": "CA",
"postal_code": "94612",
"country": "USA"
}
}
JSON
{
"token": "ext_card_12345",
"pan": "5555555555554444",
"cvv": "456",
"expiration": "0630",
"business_token": "business_67890",
"billing_details": {
"business_name": "Acme Corp",
"address_1": "500 Market Street",
"address_2": "Suite 200",
"city": "San Francisco",
"country_subdivision": "CA",
"postal_code": "94105",
"country": "USA"
}
}
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the external card. Allowable Values: 36 char max |
| expiration string Conditionally returned | Expiration date of the external card. Allowable Values: Format: MMyy |
| last_four string Conditionally returned | Last four digits of the primary account number (PAN) of the external card. Allowable Values: 4 char |
| issuing_bank string Conditionally returned | Issuing bank of the external card. Allowable Values: Bank name, as provided by the card network |
| network string Conditionally returned | Name of the card network. Allowable Values: 255 char max |
| status string Conditionally returned | Status of the external card. Allowable Values: ACTIVE, SUSPENDED, TERMINATED |
| user_token string Conditionally returned | Unique identifier of the user. Allowable Values: 36 char max |
| business_token string Conditionally returned | Unique identifier of the business. Allowable Values: 36 char max |
| billing_details object Conditionally returned | Billing details. Allowable Values: Valid billing details object |
| billing_details.first_name string Conditionally returned | First name or given name of the external account holder. Allowable Values: 40 char max |
| billing_details.middle_name string Conditionally returned | Middle name of the external account holder. Allowable Values: 40 char max |
| billing_details.last_name string Conditionally returned | Last or family name of the external account holder. Allowable Values: 40 char max |
| billing_details.business_name string Conditionally returned | Business name of the external account holder. Allowable Values: 40 char max |
| billing_details.address_1 string Returned | Street name and number of the external account holder’s address. Allowable Values: 255 char max |
| billing_details.address_2 string Conditionally returned | Additional external account holder address information. Allowable Values: 255 char max |
| billing_details.city string Returned | City of the external account holder’s address. Allowable Values: 40 char max |
| billing_details.country_subdivision string Returned | Two-character state, province, or territorial abbreviation. For a complete list of valid abbreviations, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 chars |
| billing_details.postal_code string Returned | Postal code of the external account holder’s address. Allowable Values: 20 char max |
| billing_details.country string Returned | Country of the external account holder’s address in a valid alpha-3 ISO 3166 country code. Allowable Values: 3 chars |
| is_eligible_for_pull boolean Conditionally returned | A value of true indicates that the external card is eligible for pulling funds.Allowable Values: true, false |
| is_eligible_for_push boolean Conditionally returned | A value of true indicates that the external card is eligible for pushing funds.Allowable Values: true, false |
| is_eligible_for_disbursement boolean Conditionally returned | A value of true indicates that the external card is eligible for disbursement.Allowable Values: true, false |
| created_time datetime Conditionally returned | Date and time when the external card was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_modified_time datetime Conditionally returned | Date and time when the external card was updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "ext_card_12345",
"expiration": "1230",
"last_four": "1111",
"status": "ACTIVE",
"user_token": "user_67890",
"billing_details": {
"first_name": "Jane",
"last_name": "Doe",
"address_1": "123 Main Street",
"city": "Oakland",
"country_subdivision": "CA",
"postal_code": "94612",
"country": "USA"
},
"is_eligible_for_pull": true,
"is_eligible_for_push": true,
"is_eligible_for_disbursement": true,
"created_time": "2025-01-15T17:30:45Z",
"last_modified_time": "2025-01-15T17:30:45Z"
}