Create external account

Create a new external account for the authenticated customer.

External accounts represent customer-owned financial accounts such as bank accounts, crypto wallets, or digital wallets that can be used in payment intents.

The customer ID is automatically extracted from the JWT bearer token.

For bank accounts, the countryCode field is required in the bankAccount object and must be a valid ISO 3166-1 alpha-2 country code (e.g., “US”, “BR”, “AR”).

POST /customers/external-accounts

Create external account

cURL

curl --request POST \
  --url https://app.gnosisramp.com/api/v1/customers/external-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "BANK_ACCOUNT",
  "label": "Personal Checking Account",
  "bankAccount": {
    "countryCode": "US"
  }
}
'

201

{
  "id": "ext_acc_12345",
  "type": "BANK_ACCOUNT",
  "currencyId": "usd-currency-id",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "metadata": {},
  "label": "Personal Checking Account",
  "customerId": "customer-123",
  "currency": {
    "id": "usd-currency-id",
    "ticker": "USDC",
    "name": "USD Coin",
    "code": "USDC_ETH",
    "decimals": 6,
    "type": "FIAT",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Authorizations

Authorization · string · header · required

uRamp JWT bearer token for authenticated customer requests

Body

application/json

Option 1

Option 2

Request to create an external account (bank account or crypto address)

type · enum<string> · required

External account type

Available options: BANK_ACCOUNT

label · string · required

Human-readable label for the external account

Example:

"Personal Checking Account"

bankAccount · object · required

Bank account details (structure varies by country)

Show child attributes

Response

201

application/json

External account created successfully

External account with currency relation

id · string · required

Unique external account identifier

Example:

"ext_acc_12345"

type · enum<string> · required

External account type

Available options: BANK_ACCOUNT, CRYPTO_ADDRESS

Example:

"BANK_ACCOUNT"

currencyId · string · required

Currency identifier

Example:

"usd-currency-id"

createdAt · string<date-time> · required

Account creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

updatedAt · string<date-time> · required

Account last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

metadata · object

Account-specific metadata (structure varies by type)

label · string

Human-readable label for the account

Example:

"Personal Checking Account"

customerId · string | null

Customer identifier (if associated with a customer)

Example:

"customer-123"

currency · object

Currency entity

Show child attributes