Skip to main content
POST
/
api
/
recipients
/
create
Create Recipient
curl --request POST \
  --url http://127.0.0.1:8083/api/recipients/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "partner_recipient_id": "<string>",
  "business_name": "<string>",
  "business_type": "Business",
  "country_code": "CN",
  "website": "https://www.example.com",
  "address_info": {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "post_code": "<string>"
  },
  "payment_details": {
    "account_type": "bank",
    "bank_name": "JPMorgan Chase",
    "network": "SWIFT",
    "payment_method": "INTERNATIONAL_WIRE",
    "account_name": "<string>",
    "account_number": "<string>",
    "swift_code": "<string>",
    "account_currency": "USD",
    "country_code": "US",
    "local_bank_code": "<string>"
  },
  "file_id_list": [
    "<string>"
  ]
}
'
{
  "name": "<string>",
  "type": "<string>",
  "website": "<string>",
  "recipient_id": "<string>",
  "partner_recipient_id": "<string>",
  "status": "Processing,Succeeded,Failed,Suspended",
  "country_code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "address_info": {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "post_code": "<string>"
  },
  "payment_details": {
    "account_type": "bank",
    "bank_name": "JPMorgan Chase",
    "network": "SWIFT",
    "payment_method": "INTERNATIONAL_WIRE",
    "account_name": "<string>",
    "account_number": "<string>",
    "swift_code": "<string>",
    "account_currency": "USD",
    "country_code": "US",
    "local_bank_code": "<string>"
  },
  "file_id_list": [
    "<string>"
  ]
}

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.

Body

application/json
​
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"

​
website
string

Website

Maximum string length: 225
Example:

"https://www.example.com"

​
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

Response

Operation Successful

​
name
string
required
​
type
string
required
​
website
string
required
​
recipient_id
string
​
partner_recipient_id
string
​
status
string

Status

Example:

"Processing,Succeeded,Failed,Suspended"

​
country_code
string
​
created_at
string<date-time>
​
address_info
object
​
payment_details
object

Payment details

​
file_id_list
string[]