Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
Create external account
Create an external account for the user.
curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "card",
"label": "My Visa Card",
"number": "4111111111111111",
"securityCode": "123",
"expiryDate": {
"month": 12,
"year": 2030
}
}'
{
"externalAccount": {
"id": "aa6e6efa-8d73-497c-8278-0347f459bd68",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "processing",
"label": "My Visa Card",
"asset": "GBP",
"details": {
"last4Digits": "1519",
"expiryDate": {
"month": 12,
"year": 2030
}
},
"createdAt": "2024-06-01T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
}
}
Authorizations
OAuth 2.0 authentication.
Body
The type of the external account.
card
The label of the external account.
140
The number of the card.
The security code of the card.
Response
The unique identifier of the external account.
The unique identifier of the user that owns the account.
The type of the external account.
card
The status of the external account.
processing
, ok
, failed
, restricted
, blocked
The label of the external account.
The asset in which the external account is denominated.
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.
credit
, debit
The details of the status of the external account.
The reason why the external account linkage failed.
card-data-invalid
, card-declined-by-bank
, card-expired
, card-permanently-declined-by-bank
, card-unauthorized
, card-unsupported
, unspecified-error
, velocity
curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "card",
"label": "My Visa Card",
"number": "4111111111111111",
"securityCode": "123",
"expiryDate": {
"month": 12,
"year": 2030
}
}'
{
"externalAccount": {
"id": "aa6e6efa-8d73-497c-8278-0347f459bd68",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "card",
"status": "processing",
"label": "My Visa Card",
"asset": "GBP",
"details": {
"last4Digits": "1519",
"expiryDate": {
"month": 12,
"year": 2030
}
},
"createdAt": "2024-06-01T00:00:00Z",
"updatedAt": "2024-07-15T00:00:00Z"
}
}