Get recipient
Recipients
Get recipient
Retrieve a single recipient by ID
GET
Get recipient
Overview
Retrieve details for a specific recipient belonging to the authenticated merchant. The response shape depends on the recipient’stype: BANK_ACCOUNT, CRYPTO_ADDRESS, US_BANK_ACCOUNT, or SWIFT_BANK_ACCOUNT. Only the field matching the type is populated; the others are null.
Authentication
Your merchant API key
Path Parameters
Recipient ID (UUID)Example:
750e8400-e29b-41d4-a716-446655440000Request Example
Response
Unique recipient identifier (UUID)
Recipient type.Allowed values:
BANK_ACCOUNT | CRYPTO_ADDRESS | US_BANK_ACCOUNT | SWIFT_BANK_ACCOUNTRecipient first name (for individual recipients).
Recipient last name (for individual recipients).
NGN bank account details. Present when
type is BANK_ACCOUNT, null otherwise.Crypto address details. Present when
type is CRYPTO_ADDRESS, null otherwise.US bank account details. Present when
type is US_BANK_ACCOUNT, null otherwise.SWIFT bank account details. Present when
type is SWIFT_BANK_ACCOUNT, null otherwise.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