> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# External Cards
> Use the externalcards endpoints to manage instant funding for external debit and prepaid cards.
export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
const METHOD_STYLES = {
GET: {
bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
text: "mint-text-green-700 dark:mint-text-green-400",
border: "mint-border-green-300 dark:mint-border-green-700"
},
POST: {
bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
text: "mint-text-blue-700 dark:mint-text-blue-400"
},
PUT: {
bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
text: "mint-text-yellow-700 dark:mint-text-yellow-400"
},
PATCH: {
bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
text: "mint-text-orange-700 dark:mint-text-orange-400"
},
DELETE: {
bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
text: "mint-text-red-700 dark:mint-text-red-400"
},
API: {
bg: "mint-bg-black",
text: "mint-text-white"
}
};
const MethodBadge = ({method}) => {
const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
return
{method?.toUpperCase()}
;
};
const content =
{}
{}
{title}
{children &&
{children}
}
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](/core-api/kyc-verification#_valid_state_provincial_territorial_and_federal_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](/core-api/kyc-verification#_valid_state_provincial_territorial_and_federal_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](/core-api/kyc-verification#_valid_state_provincial_territorial_and_federal_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](/core-api/kyc-verification#_valid_state_provincial_territorial_and_federal_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](/core-api/kyc-verification#_valid_state_provincial_territorial_and_federal_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` |