Create an external account

Create canonical external account details and map to provider accounts

POST /api/grid/v1/accounts/{address}/external-accounts

Create an external account

cURL

curl --request POST \
  --url https://grid.squads.xyz/api/grid/v1/accounts/{address}/external-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-grid-environment: <x-grid-environment>' \
  --data '
{
  "account": {},
  "beneficiary": {},
  "idempotency_key": "<string>",
  "is_third_party": true
}
'

201

{
  "active": true,
  "beneficiary_kind": "<string>",
  "beneficiary_name": "<string>",
  "country_code": "<string>",
  "created_at": "<string>",
  "currency": "<string>",
  "id": "<string>",
  "provider_accounts": [
    {
      "created_at": "<string>",
      "provider": "<string>",
      "provider_internal_id": "<string>",
      "rails": [
        "<string>"
      ],
      "status": "<string>",
      "last_error": "<string>"
    }
  ],
  "last_4": "<string>"
}

Authorizations

Authorization · string · header · required

Your Grid API key from the Grid Dashboard

Headers

x-grid-environment · string · required

Environment (sandbox, production)

Path Parameters

address · string · required

Smart account address

Body

application/json

account · object · required

beneficiary · object · required

idempotency_key · string · required

is_third_party · boolean | null

Response

201

application/json

External account created

active · boolean · required

beneficiary_kind · string · required

beneficiary_name · string · required

country_code · string · required

created_at · string · required

currency · string · required

id · string · required

provider_accounts · object[] · required

Show child attributes

last_4 · string | null