Skip to main content
POST
/
v1
/
payout-accounts
Create a payout account
curl --request POST \
  --url https://api.ledger.so/v1/payout-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cus_abc123",
  "type": "us_bank",
  "label": "My checking account",
  "details": {
    "routingNumber": "021000021",
    "accountNumber": "123456789"
  }
}
'
{
  "ok": true,
  "data": {
    "id": "pa_abc123",
    "customerId": "cus_abc123",
    "type": "us_bank",
    "createdAt": "2023-11-07T05:31:56Z",
    "label": "My checking account",
    "details": {}
  }
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token. Format: ld_<env>_<prefix>_<secret> where <env> is test or live.

Headers

​
Idempotency-Key
string

Unique key to ensure idempotent request processing. Reusing a key for a different route or method returns 409 Conflict.

Example:

"idk_a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
​
customerId
string
required

The customer this payout account belongs to.

​
type
enum<string>
required
Available options:
us_bank,
iban,
clabe,
pix,
gb_bank,
mobile_money,
ghipss,
nip,
swift
​
details
object
required

Account-type-specific fields. For us_bank: routingNumber, accountNumber. For iban: iban, bic.

​
label
string

A human-readable label for this account.

Response

Payout account created

​
ok
boolean
required

Indicates the request was successful.

​
data
object