curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "bank",
"asset": "USD",
"network": "ach",
"label": "My ACH Bank Account",
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "San Francisco",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "94102"
},
"routingNumber": "121000248",
"accountNumber": "9876543210",
"accountType": "checking"
}
'{
"externalAccount": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "bank",
"status": "ok",
"label": "My ACH Bank Account",
"asset": "USD",
"network": "ach",
"features": [
"withdraw"
],
"details": {
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "San Francisco",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "94102"
},
"routingNumber": "121000248",
"accountNumber": "9876543210",
"accountType": "checking",
"secondaryNetworks": {
"withdraw": [
"fednow"
]
}
},
"createdAt": "2024-06-01T00:00:00.000Z",
"updatedAt": "2024-07-15T00:00:00.000Z"
}
}External accounts
Create external account
Create an external account for the user.
POST
/
core
/
external-accounts
curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/external-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "bank",
"asset": "USD",
"network": "ach",
"label": "My ACH Bank Account",
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "San Francisco",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "94102"
},
"routingNumber": "121000248",
"accountNumber": "9876543210",
"accountType": "checking"
}
'{
"externalAccount": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
"type": "bank",
"status": "ok",
"label": "My ACH Bank Account",
"asset": "USD",
"network": "ach",
"features": [
"withdraw"
],
"details": {
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "San Francisco",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "94102"
},
"routingNumber": "121000248",
"accountNumber": "9876543210",
"accountType": "checking",
"secondaryNetworks": {
"withdraw": [
"fednow"
]
}
},
"createdAt": "2024-06-01T00:00:00.000Z",
"updatedAt": "2024-07-15T00:00:00.000Z"
}
}
You can optionally include custom entity metadata in the
metadata field to store your own business data (e.g., cardholder name, tracking information, custom labels). If not provided during creation, you can add it later using Set metadata.Authorizations
OAuth 2.0 authentication.
Body
application/json
- Card
- Bank (ACH)
The type of the external account.
Available options:
card The label of the external account.
Maximum string length:
140Pattern:
^\S.*\S$|^\S$The number of the card.
Pattern:
^[0-9]{12,19}$The security code of the card.
Pattern:
^[0-9]{3,3}$Show child attributes
Show child attributes
Additional data for the external account.
Was this page helpful?