List external accounts
Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
List external accounts
List external accounts for the user.
GET
/
core
/
external-accounts
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>'
{
"externalAccounts": [
{
"id": "aa6e6efa-8d73-497c-8278-0347f459bd68",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "ok",
"label": "My Visa Card",
"asset": "GBP",
"network": "visa",
"features": [
"deposit",
"withdraw"
],
"details": {
"type": "debit",
"last4Digits": "1519",
"expiryDate": {
"month": 12,
"year": 2030
}
},
"createdAt": "2024-06-02T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
},
{
"id": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "ok",
"label": "My Mastercard Card",
"asset": "GBP",
"network": "mastercard",
"features": [
"deposit"
],
"details": {
"type": "credit",
"last4Digits": "2311",
"expiryDate": {
"month": 3,
"year": 2035
}
},
"createdAt": "2024-06-01T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
}
]
}
Authorizations
OAuth 2.0 authentication.
Response
200 - application/json
External accounts retrieved.
The unique identifier of the external account.
The unique identifier of the user that owns the account.
The type of the external account.
Available options:
card
The status of the external account.
Available options:
processing
, ok
, failed
, restricted
, blocked
The label of the external account.
The asset in which the external account is denominated.
The features of the external account.
Available options:
withdraw
, deposit
The time at which the external account was created.
The last time at which the external account was updated.
Card details.
The last 4 digits of the card number.
The type of the card, available if card was recognized.
Available options:
credit
, debit
The details of the status of the external account.
The reason why the external account linkage failed.
Available options:
card-data-invalid
, card-declined-by-bank
, card-expired
, card-permanently-declined-by-bank
, card-unauthorized
, card-unsupported
, velocity
, unspecified-error
The network that the external account corresponds to.
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>'
{
"externalAccounts": [
{
"id": "aa6e6efa-8d73-497c-8278-0347f459bd68",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "ok",
"label": "My Visa Card",
"asset": "GBP",
"network": "visa",
"features": [
"deposit",
"withdraw"
],
"details": {
"type": "debit",
"last4Digits": "1519",
"expiryDate": {
"month": 12,
"year": 2030
}
},
"createdAt": "2024-06-02T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
},
{
"id": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "ok",
"label": "My Mastercard Card",
"asset": "GBP",
"network": "mastercard",
"features": [
"deposit"
],
"details": {
"type": "credit",
"last4Digits": "2311",
"expiryDate": {
"month": 3,
"year": 2035
}
},
"createdAt": "2024-06-01T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
}
]
}