Object

The payout account object

Fields

idstringrequired

Starts with pa_.

objectstringrequired

user_idstringrequired

Starts with usr_.

typestringrequired

Which rails serve each type is data on GET /routes. In 1.0, bank is paid by Absa (absa_eft) and paypal by PayPal. No mobile_money rail has a provider yet.

One of bank, mobile_money, paypal.

currencystringrequired

Lower-case ISO 4217 fiat currency code.

countrystringrequired

ISO 3166-1 alpha-2 country code.

railstringrequired

A payment rail code, published by GET /routes. Not an enum by design.

account_owner_namestringrequired

bankobject

bank.bank_namestring

bank.account_number_last4string

bank.routing_codestring

bank.swift_bicstring

bank.account_typestring

mobile_moneyobject

mobile_money.providerstring

mobile_money.phone_number_last4string

paypalobject

paypal.email_maskedstring

The email with most of the local part hidden, like a***e@example.com.

paypal.phone_number_last4string

statusstringrequired

One of active, deleted.

name_checkstringrequired

Result of verifying account_owner_name with the rail. not_supported until then.

One of not_supported, pending, match, partial_match, no_match.

metadataobject

Integrator key-value data, returned unchanged. Up to 50 keys; keys up to 40 characters, values up to 500.

versionintegerrequired

created_attimestamprequired

Example

{
  "id": "pa_01JA8Z6N3P4Q5R6S7T8U9V0WXY",
  "object": "payout_account",
  "user_id": "usr_01JA8Z3H6J7K8M9N0P1Q2R3S4T",
  "type": "bank",
  "currency": "zar",
  "country": "ZA",
  "rail": "absa_eft",
  "account_owner_name": "Tendai Ncube",
  "bank": {
    "bank_name": "Absa Bank",
    "account_number_last4": "4567",
    "routing_code": "632005",
    "account_type": "checking"
  },
  "status": "active",
  "name_check": "not_supported",
  "metadata": {},
  "version": 1,
  "created_at": "2026-10-16T09:30:00Z"
}