Add external card
Action:POST
Endpoint: /v3/moneymovement/externalcards
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. 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 |
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 |
List external cards
Action:GET
Endpoint: /v3/moneymovement/externalcards/accountholders/{account_holder_token}
Retrieves a list of external cards associated with a specific account holder.
URL path parameters
| Fields | Description |
|---|---|
| account_holder_token string Required | Unique identifier of the account holder (user or business). Allowable Values: Valid account holder token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of card resources to retrieve. Allowable Values: 1–50 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of external card resources returned. Allowable Values: 1-10 |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Conditionally returned | Array of external card objects. Allowable Values: Valid array of one or more card objects |
| data[].token string Conditionally returned | Unique identifier of the external card. Allowable Values: 36 char max |
| data[].expiration string Conditionally returned | Expiration date of the external card. Allowable Values: Format: MMyy |
| data[].last_four string Conditionally returned | Last four digits of the primary account number (PAN) of the external card. Allowable Values: 4 char |
| data[].issuing_bank string Conditionally returned | Issuing bank of the external card. Allowable Values: Bank name, as provided by the card network |
| data[].network string Conditionally returned | Name of the card network. Allowable Values: 255 char max |
| data[].status string Conditionally returned | Status of the external card. Allowable Values: ACTIVE, SUSPENDED, TERMINATED |
| data[].user_token string Conditionally returned | Unique identifier of the user. Allowable Values: 36 char max |
| data[].business_token string Conditionally returned | Unique identifier of the business. Allowable Values: 36 char max |
| data[].billing_details object Conditionally returned | Billing details. Allowable Values: Valid billing details object |
| data[].billing_details.first_name string Conditionally returned | First name or given name of the external account holder. Allowable Values: 40 char max |
| data[].billing_details.middle_name string Conditionally returned | Middle name of the external account holder. Allowable Values: 40 char max |
| data[].billing_details.last_name string Conditionally returned | Last or family name of the external account holder. Allowable Values: 40 char max |
| data[].billing_details.business_name string Conditionally returned | Business name of the external account holder. Allowable Values: 40 char max |
| data[].billing_details.address_1 string Returned | Street name and number of the external account holder’s address. Allowable Values: 255 char max |
| data[].billing_details.address_2 string Conditionally returned | Additional external account holder address information. Allowable Values: 255 char max |
| data[].billing_details.city string Returned | City of the external account holder’s address. Allowable Values: 40 char max |
| data[].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 |
| data[].billing_details.postal_code string Returned | Postal code of the external account holder’s address. Allowable Values: 20 char max |
| data[].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 |
| data[].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 |
| data[].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 |
| data[].is_eligible_for_disbursement boolean Conditionally returned | A value of true indicates that the external card is eligible for disbursement.Allowable Values: true, false |
| data[].created_time datetime Conditionally returned | Date and time when the external card was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].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 |
Retrieve external card
Action:GET
Endpoint: /v3/moneymovement/externalcards/{token}
Retrieves an external card using the specified external card token.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the external card, as returned by the POST /externalcards endpoint.Allowable Values: Valid external card token |
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 |
Update external card
Action:PATCH
Endpoint: /v3/moneymovement/externalcards/{token}
Updates an external card.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the external card, as returned by the POST /externalcards endpoint.Allowable Values: Valid external card token |
Request body
| Fields | Description |
|---|---|
| status string Required | Status to which to update the external card. Allowable Values: TERMINATED, SUSPENDED, ACTIVE |
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 |