Payee Add

API Information

• Path: /api/v1/beneficiary/add
• Method: POST
• Content-Type: application/json

Business Description

• This is a prerequisite step before using the Payment Initiation API. You must first add a payee before you can proceed with payment initiation.
• After a payee is successfully added, a beneficiaryId (Payee ID) will be returned, which is required for subsequent payment operations.

Duplicate Creation Notice

• The system returned an error status without a detailed message. This request may have attempted to create a payee that already exists.
• Please use the cardNumber to call the Payee List Query API , retrieve the existing payeeId, and use that payeeId for subsequent payout operations.

Request Parameters

Headers

Request Headers

Parameter	Value	Required	Description
Content-Type	application/json	Yes	Request body type

Request Body

Main Parameters

Parameter	Type	Description	Required
merchantNo	string	The merchant number of the request initiator.	M
onBehalfOf	string	The merchant number that the request is actually associated with. Provide this field only when initiating a request on behalf of another merchant.	N
merchantRefId	string(64)	Unique identifier for the recipient in your system	N
bankCountry	string(12)	Submit payment Country	M
payoutCurrency	string(128)	Payout Currency	M
entityType	string(1)	Entity Type [0:Company, 1:Individual]	M
paymentMethod	string	Payment Method	M
receiverInfo	string(1024)	Payee Information	M
address	string(1024)	Address Information	M
accountInfomation	string(1024)	Account information	M
sign	string	Signature	M

Request Example

Request

{
  "merchantNo": "800181",
  "bankCountry": "US",
  "payoutCurrency": "USD",
  "entityType": "1",
  "paymentMethod": "BANK_TRANSFER",
  "sign": "",
  "receiverInfo": "{\"companyName\":\"\",\"lastName\":\"USDMDD\",\"firstName\":\"DAN\",\"areaCode\":\"\",\"phone\":\"\",\"email\":\"hynchen@onerway.com\",\"identityType\":\"SSN\"}",
  "address": "{\"countryCode\":null,\"state\":\"CALIFORNIA\",\"city\":\"Adin\",\"addressLine1\":\"ADRESS TEST 1\",\"addressLine2\":null,\"addressLine3\":null,\"postalCode\":\"890890\"}",
  "accountInfomation": "{\"cardNumber\":\"3890601780555\",\"accountType\":\"1\",\"swiftCode\":\"ABOCUS33\",\"bankName\":\"MCB BankLimited\", \"sortCode\": \"021001088\", \"bankAccount\": \"AGRICULTURAL BANK OF CHINA NEW YORK BRANCH\"}"
}

Response Result

Response Headers

Parameter	Value	Required	Description
content-type	application/json;charset=UTF-8	Yes	Response body type

Response Parameters

Parameter	Type	Description
respCode	string	Response Code
respMsg	string	Response Message
data	object	Response Data
└─beneficiaryId	integer	Payee ID
└─payeeStatus	string	Payee Status/payeeStatus

Response Example

Response

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "beneficiaryId": 123456,
    "payeeStatus": "WAITING"
  }
}