Skip to main content
GET
Get recipient

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer the recipient belongs to. Must be a cus_… reference id — a UUID is rejected with 400.

recipientId
string
required

The recipient. Must be a rec_… reference id — a UUID is rejected with 400.

Response

The recipient. Unwrapped.

A recipient, unwrapped. Keys with no value are left out, except inside the two address objects. alias is never returned.

id
string

rec_… reference id.

userId
string

cus_… id of the owning customer.

type
enum<string>

INDIVIDUAL or BUSINESS.

Available options:
INDIVIDUAL,
BUSINESS
firstName
string

First name. For a BUSINESS recipient this holds the business name.

lastName
string

Contact detail.

email
string

Contact detail.

phone
string

Contact detail.

dateOfBirth
string

Returned as YYYY-MM-DD (sent as DD-MM-YYYY on Add recipient).

nationality
string

Individual identity detail, where the corridor needs it.

gender
string

Individual identity detail, where the corridor needs it.

occupation
string

Individual identity detail, where the corridor needs it.

governmentId
string

Individual identity detail, where the corridor needs it.

governmentIdType
string

Individual identity detail, where the corridor needs it.

businessStructure
string

Business detail.

businessRegistrationCountry
string

Business detail.

bankName
string

Bank detail for the rail.

bankAccountNumber
string

Bank detail for the rail.

bankRoutingNumber
string

Bank detail for the rail.

bankBranchCode
string

Bank detail for the rail.

bankBranchName
string

Bank detail for the rail.

iban
string

Bank detail for the rail.

swiftBic
string

Bank detail for the rail.

ifsc
string

Bank detail for the rail.

sortCode
string

Bank detail for the rail.

accountType
string

Bank detail for the rail.

providerBankId
string

Bank detail for the rail — the receiving bank's code, as sent on Add recipient.

walletAddress
string

Payout wallet, for CRYPTO recipients.

walletChain
string

Payout wallet chain, for CRYPTO recipients.

recipientAddress
object

The recipient's address. Always present; inner fields may be null.

institutionalAddress
object

The bank's address, same fields. Always present; inner fields may be null.

currency
string

Payout currency.

currencySymbol
string

Payout currency symbol.

currencyId
integer

Payout currency id.

payoutRail
string

Payout rail, e.g. ACH, SEPA, BANK_TRANSFER, CRYPTO.

relationshipToCustomer
string

Relationship to the customer, e.g. FRIEND, SUPPLIER.

wireMessage
string

Default memo sent with wires.

addedToAccountsProvider
boolean

Registered with the payout provider.

statusAccountsProvider
string

Provider status: PENDING, ACTIVE, OPEN, CLOSED, FROZEN, EDD, DORMANT (plus _L2F variants). Only ACTIVE can be paid.

statusAccountsProviderUpdatedOn
string

ISO 8601 time of the last provider status change.

counterpartyId
string

Provider-side id. Opaque.

flag
string

Country name of the payout currency, for display.

invoiceMandatory
boolean

true when a transfer to this recipient must carry an invoice.

isNewKyc
boolean

Internal. Do not branch on it.

deleted
boolean

Always false in a list.

createdOn
string

ISO 8601 timestamp.

updatedOn
string

ISO 8601 timestamp.