Skip to main content
GET
Get recipient

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

recipientId
string<uuid>
required

Response

200 - application/json

Recipient details returned successfully

id
string<uuid>
country
string

ISO 3166-1 alpha-2 code

Pattern: ^[A-Z]{2,2}$
currency
string

ISO 4217 alpha code

Pattern: ^[A-Z]{3,3}$
method
enum<string>
Available options:
BANK_ACCOUNT,
BPAY,
INTERAC,
ALIPAY,
FPS_ID,
MPESA,
PAYGATE,
DUITNOW,
GOPAY,
OVO,
DANA,
LINKAJA,
SHOPEEPAY,
PAYMAYA,
GCASH,
GRABPAY,
STARPAY,
BAYAD,
TAYOCASH,
JUANCASH,
UNIONPAY_CARD
isDefault
boolean
creditor
object
creditorAccount
object
creditorAgent
object