Recipients

object

string

Always "recipient"

id

string (UUID)

Unique identifier for the recipient

user_id

string (UUID)

ID of the user who owns this recipient

profile_id

string (UUID)

ID of the associated profile

active

boolean

Whether the recipient is active

owned_by_customer

boolean

Whether the recipient is owned by the customer

created_at

string (ISO 8601)

When the recipient was created

updated_at

string (ISO 8601)

When the recipient was last updated

currency_id

string

Currency code (NGN, USD, GBP, KES, BTC, ETH, USDT, XLM, etc.)

country_id

string

ISO country code (NG, US, GB, KE, null for crypto)

type

string (enum)

Specific recipient type (see Types section)

category

string (enum)

General category: bank, mobile_money, crypto

entity_type

string

Entity type: personal or business (nullable, used for US/GB)

transfer_type

string

Transfer method: ach, wire, swift (nullable, used for US)

account_name

string

Account holder name or wallet label (nullable)

bank_name

string

Name of the bank (nullable)

bank_code

string

Bank code (nullable, used for Nigeria)

sort_code

string

Sort code (nullable, used for UK)

routing_number

string

Routing number (nullable, used for US ACH/Wire)

swift_code

string

SWIFT code (nullable, used for international transfers)

account_number

string

Domestic account number (nullable)

iban

string

International account number (nullable, used for SWIFT)

phone_number

string

Mobile money phone number (nullable)

network

string

Blockchain network (nullable, used for crypto)

crypto_address

string

Wallet address (nullable, used for crypto)

memo

string

Memo/tag for crypto transfers (nullable)

recipient_address

string

Recipient address for international transfers (nullable)

intermediary_bank_name

string

Intermediary bank name (nullable, used for SWIFT)

intermediary_bank_address

string

Intermediary bank address (nullable, used for SWIFT)

intermediary_swift_code

string

Intermediary bank SWIFT code (nullable, used for SWIFT)