Skip to main content
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

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
type
enum<string>
required

The type of the external account.

Available options:
card
​
label
string
required

The label of the external account.

Maximum string length: 140
Pattern: ^\S.*\S$|^\S$
​
number
string
required

The number of the card.

Pattern: ^[0-9]{12,19}$
​
securityCode
string
required

The security code of the card.

Pattern: ^[0-9]{3,3}$
​
expiryDate
object
required
​
metadata
object

Additional data for the external account.

Response

External account created.

​
externalAccount
object
required
​
errors
object

Additional contextual errors that occurred while processing the request.