Skip to main content
GET
Get recipient

Overview

Retrieve details for a specific recipient belonging to the authenticated merchant. The response shape depends on the recipient’s type: BANK_ACCOUNT, CRYPTO_ADDRESS, US_BANK_ACCOUNT, or SWIFT_BANK_ACCOUNT. Only the field matching the type is populated; the others are null.

Authentication

X-Api-Key
string
required
Your merchant API key

Path Parameters

id
string
required
Recipient ID (UUID)Example: 750e8400-e29b-41d4-a716-446655440000

Request Example

Response

id
string
required
Unique recipient identifier (UUID)
type
string
required
Recipient type.Allowed values: BANK_ACCOUNT | CRYPTO_ADDRESS | US_BANK_ACCOUNT | SWIFT_BANK_ACCOUNT
first_name
string
Recipient first name (for individual recipients).
last_name
string
Recipient last name (for individual recipients).
bank_account
object
NGN bank account details. Present when type is BANK_ACCOUNT, null otherwise.
crypto_address
object
Crypto address details. Present when type is CRYPTO_ADDRESS, null otherwise.
us_bank_account
object
US bank account details. Present when type is US_BANK_ACCOUNT, null otherwise.
swift_bank_account
object
SWIFT bank account details. Present when type is SWIFT_BANK_ACCOUNT, null otherwise.
created_at
string
required
When the recipient was created (ISO 8601 timestamp)

Success Response

Error Responses

Next Steps

List recipients

Retrieve all saved recipients

Delete recipient

Remove a payout recipient