收款方添加

接口信息

• 路径: /api/v1/beneficiary/add
• 方法: POST
• Content-Type: application/json

业务说明

• 这是使用付款API的前置步骤，须先添加收款人，才能进行付款
• 添加成功后会返回beneficiaryId(收款人ID)，该ID将用于后续的付款操

重复创建提示

• 系统返回错误状态但未提供具体的报错信息。本次请求可能为重复创建收款方。
• 请根据银行账号调用收款方列表查询，获取已有的 payeeId，并使用该 payeeId 进行后续付款下发。

请求参数

Headers

请求头

参数名	值	必填	说明
Content-Type	application/json	是	请求体类型

Request Body

主要参数

参数名	类型	说明	必填
merchantNo	string	商户号	M
bankCountry	string(12)	付款国家	M
payoutCurrency	string(128)	出款币种	M
entityType	string(1)	主体类型 [0:企业,1:个人]	M
paymentMethod	string	付款方式	M
receiverInfo	string(1024)	收款人信息	M
address	string(1024)	地址信息	M
accountInfomation	string(1024)	账户信息	M
sign	string	签名	M

请求示例

Request

{
  "merchantNo": 801129,
  "bankCountry": "PK",
  "payoutCurrency": "PKR",
  "entityType": "1",
  "paymentMethod": "E_WALLET",
  "sign": "d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842282q6",
  "receiverInfo": "{\"companyName\":\"helloBoy\",\"lastName\":\"test\",\"firstName\":\"beta\",\"areaCode\":\"+92\",\"phone\":\"2313019452\",\"birthDate\":\"1991-12-04\",\"email\":\"jing.yuan1@onerway.com\",\"identityType\":\"SSN\",\"vatNumber\":\"8859884832\"}",
  "address": "{\"countryCode\":null,\"state\":\"NY\",\"city\":\"Adin\",\"townName\":null,\"addressLine1\":\"testdsgddfs1233\",\"addressLine2\":null,\"addressLine3\":null,\"postalCode\":\"10005\"}",
  "accountInfomation": "{\"cardNumber\":null,\"accountType\":null,\"swiftCode\":null,\"sortCode\":null,\"branchCode\":null,\"bankHolderName\":null,\"walletType\":\"EASYPAISA\",\"walletPhone\":\"03079770877\",\"pickUpBankName\":null,\"pickUpBankBranchName\":null,\"pickUpBankBranchId\":null,\"pickUpBankBranchAddress\":null}"
}

响应结果

响应头 Headers

参数名	值	必填	说明
content-type	application/json;charset=UTF-8	是	响应体类型

响应参数

参数名	类型	说明
respCode	string	响应码
respMsg	string	响应信息
data	object	响应数据
└─beneficiaryId	integer	收款人ID
└─payeeStatus	string	收款人状态/payeeStatus

响应示例

Response

{
  "respCode": "20000",
  "respMsg": null,
  "data": {
    "beneficiaryId": "1984102812163112960",
    "payeeStatus": "unnecessary"
  }
}