Skip to main content
GET
Get Recipient Details

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Query Parameters

partner_recipient_id
string

Partner Recipient Id

recipient_id
string

Recipient Id

Response

Operation Successful

partner_recipient_id
string
required

Partner Assigned Recipient ID

Required string length: 20 - 64
business_name
string
required

Business Name

Required string length: 2 - 128
business_type
enum<string>
required

Business Type

Available options:
Business,
Individual
Pattern: ^(Business|Individual)$
country_code
enum<string>
required

Country Code

Available options:
CN
Pattern: ^(CN)$
Example:

"CN"

recipient_id
string

Unique Recipient ID

Example:

"rcp_ff624a5b02d44c98af91698e0bc69118"

status
enum<string>

Status

Available options:
pending,
active,
rejected,
suspended
Example:

"active"

website
string

Website

Maximum string length: 225
Example:

"https://www.example.com"

created_at
string<date-time>
address_info
object

Address Information

payment_details
object

Payment details

file_id_list
string[]

List of file IDs

Maximum array length: 10

List of file IDs