Apply to pay

• Endpoint: POST /v2/delSuffixStart10
• Tags: Disbursement

Description

This interface is an API payment interface. Please pay attention to the following matters when returning parameters of this interface, otherwise there may be a risk of capital loss:

1. When "bizCode": "0000" and tradeNo is returned, it means the order is successfully placed. Please refer to the callback or query interface status for the order status;
2. When "bizCode": "4000" and "message": "Duplicate orderId/orderId already exist", it means that the orderId has already placed an order. Please wait for the callback or query interface to confirm the order status. Make sure that the orderId is unique each time you place an order;
3. In other scenarios, please check the parameters and reinitiate without changing the orderId;

Note that the request address does not contain the interface description in brackets

Parameters

Field	In	Type	Required	Constraints	Description
sign	header	string	Yes

Parameter Examples

• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
version	string	Yes	maxLength: 5	API version.
bizType	string	Yes	maxLength: 32	Business code, “singlePayment” needs to be entered here for this API.
merchantId	string	Yes	maxLength: 32	Merchant ID assigned by PayerMax.
orderId	string	Yes	maxLength: 63	Merchant order id, only allows a-z, A-Z, 0-9, . Need be unique for each disbursement request.
userId	string	No	maxLength: 64, minLength: 0	The user ID by the merchant, needs to ensure the uniqueness of each user.
riskParams	string	No		Risk control business data.
bizModel	string	No	maxLength: 30	It corresponds to the business type of the contracted payment service,Only required if the trading country is India, local payment: LOCAL, cross-border payment: CB.
countryCode	string	Yes	maxLength: 32	Country code of the payee, capital letters，refer to【Supported countries and currencies】.
chargeOption	string	No		Whether charge bearer mode of fees is required, please refer: 【Disbursement Application Template and Filling Specifications】
clearingRail	string	No		Enumerated values: SWIFT, SEPA, LOCAL, corresponding to the contracted payment methods SWIFT, SEPA, and Local Banks, respectively. Please provide the value based on the actual payment method being used, please refer: 【Disbursement Application Template and Filling Specifications】
currency	string	Yes	maxLength: 3	Payment amount corresponds to currency code, capital letters, refer to【Supported countries and currencies】
paymentMethodType	string	No	maxLength: 32	Payment methods, refer to【Payment Method Types and Target Org】
targetOrg	string	No		Target organization, refer to【Payment Method Types and Target Org】.
payeeType	string	No	maxLength: 16	Payee type (PERSONAL/CORPORATION), default PERSONAL
amount	number	Yes	max: 9999999999, min: 0	Payment amount, supports up to 2 digits after the decimal point.Note: Indonesia, Vietnam, South Korea, and Chile do not support decimal amounts in local currencies
payeeAccount	string	Yes	maxLength: 64	Payee account, Fill in the corresponding account number according to the payment method.
payeeAccountType	string	No	maxLength: 5	Receiving account type
payeeName	string	No	maxLength: 100	Payee’s name, fill in different specifications in different countries-payment methods.
payeePhone	string	No	maxLength: 32	The payee’s mobile phone number is different in different countries-payment methods.
payeeDocumentType	string	No	maxLength: 5	The type of the payee’s personal identity certificate, the optional types are different in different countries, refer to 【Disbursement Application Template and Filling Specifications】
payeeDocumentId	string	No	maxLength: 50	Payee’s personal identification number. The Option type varies in different countries, refer to 【Disbursement Application Template and Filling Specifications】
payeeDocumentDate	string	No	maxLength: 10	The birth date of the payee，with format of ‘yyyy-MM-dd’
payeeBirthDate	string	No	maxLength: 10	The date corresponding to personal identification number of the payee is different in different countries, with format of ‘yyyy-MM-dd’
payeeNationality	string	No	maxLength: 2	payee Nationality, CN, US etc country code
payeeGender	string	No	maxLength: 1	payee Gender, F or M, (F=Female，M=Male)
payeeBirthCountry	string	No	maxLength: 2	payee BirthCountry, CN, US etc country code
payeeBankCode	string	No	maxLength: 32	It is used to identify the bank code of the payee under a specific financial institution, and the filling specifications are different in different countries, refer to 【Disbursement Application Template and Filling Instructions】以及【List of supported bank ranges】.
payeeBankName	string	No	maxLength: 100	Name of Beneficiary Bank
payeeBankBranch	string	No	maxLength: 6	Branch of Beneficiary Bank
checkDigit	string	No	maxLength: 4	Recipient account verification number
payeeCorAccount	string	No	maxLength: 64	Correspondence account of the payee’s bank
payeeBankCity	string	No	maxLength: 64	The city where the bank is located.
notifyAddress	string	No	maxLength: 128	The email address of the payee to receive the notification. If it is empty, no notification will be sent by default, and the merchant should notify it by itself
email	string	No	maxLength: 64	Payee’s email
city	string	No	maxLength: 64	The city where payee is located
payeePostCode	string	No	maxLength: 64	The post code of the city where payee is located
address	string	No	maxLength: 100	Address of payee, English, number, middle dash, space and dot are allowed. Due to channel constraints, this field may be subject to special processing, such as super long truncation or filling in default value.
transactionNote	string	No	maxLength: 100	Transaction note, only accepts a-z, A-Z, 0-9, .
expiryDays	string	No	maxLength: 3	The number of days when the redeem code is valid. Currently only valid in fawrycash in Egypt， Supports inputting integers from 1 to 15 (1=24Hours), other values or not passing will default to 7
passBackParams	string	No	maxLength: 256	A pass-through parameter, which will be returned the same in the notification callback API. This field is primarily to hold customized data from merchant.
sourceAccount	string	No	maxLength: 3	Currency to be deducted
destinationCurrency	string	No	maxLength: 3	Specify the receiving currency
state	string	No	maxLength: 8	state
purpose	string	No	maxLength: 32	Disbursement purpose,enumeration value, ISUBIL:Pay to utilities (i.e. water, electricity, gas bills); EPTOUR:Tourism; EPTKAG:Pay for travel tickets or travel agency fees; ISPAYR:Pay Salary; ISPAYRA:Pay Agent Salary; ISGDDS:Goods Trade; ISSCVE:Purchase and Sale of Services; ISSUPP:Supplier Payment; ISLOGS:Logistics and Transportation Service Payment; INCEN:Incentive/Promotion/User Acquisition Activity; GAME:Gaming Equipment, Game Coins, and Other Game Items; SAMENM:Same Name Business Account Transfer; PAYCMSN:Reimbursement/Benefit Distribution/Commission Distribution; SAMENMC:Legal Person/Shareholder/Director Personal Account; AGOPEXP:Agency operating expenses; ADEXP:Advertising expenses;RFND:Refund;SMCNTST:Sub merchant settlement;LGTEP:Logistics expenses;GOODPAY:Goods payment;SINVEST:Investment in shares;FINVEST:Fund investment;TAXPAY:Tax payment;LOANPAY:Payment of loans; OTHER:Other;
businessLegalName	string	No	maxLength: 70	Payment company registered name.
registrationCountry	string	No		The country where the payment company is registered, a 2-digit uppercase country code.
merchantCategoryCode	string	No		Payment company industry classification, enumeration value, DIGITAL_GOODS_MEDIA: digital entertainment products-media; DIGITAL_GOODS_APPLICATION: digital products-application software; TRAVEL_AGENCIES_AND_TRAVEL_RELATED_SERVICES: travel agencies; COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS: express services-air, land and freight forwarders; ADVERTISING_SERVICES: advertising business; TELECOMMUNICATION_SERVICE: telecommunications services; COMPUTER_NETWORKS_AND_INFORMATION_SERVICES: computer network/information services; MISCELLANEOUS_GENERAL_MERCHANDISE: e-commerce-miscellaneous department stores.
payerId	string	No	maxLength: 70	Payment company's institution/platform merchant number.
callbackUrl	string	No	maxLength: 256	Back-end callback URL for trade result.

Example

{
  "amount": 12,
  "bizType": "singlePayment",
  "orderId": "WD16764533552zzz3111",
  "userId": "abc123456789",
  "riskParams": "{\"registerName\":\"lily\",\"regTime\":\"2023-07-01 12:08:34\",\"liveCountry\":\"VN\",\"payerAccount\":\"987654XXX\",\"payerName\":\"lily\",\"taxId\":\"1234567890\"}",
  "version": "2.0",
  "paymentMethodType": "WALLET",
  "targetOrg": "DANA",
  "merchantId": "SP12345678",
  "countryCode": "ID",
  "currency": "IDR",
  "payeeAccount": "081212345678",
  "payeeBankCity": "CN",
  "payeeAccountType": "C",
  "payeeBirthDate": "2000-03-29",
  "checkDigit": "1",
  "destinationCurrency": "IDR",
  "sourceAccount": "IDR",
  "address": "ShangHai, China",
  "passBackParams": "velit ad et ullamco",
  "email": "example@gmail.com",
  "payeeCorAccount": "1234567",
  "payeeType": "PERSONAL",
  "payeeBankBranch": "ABC",
  "purpose": "GAME",
  "payeeName": "payee's name",
  "payeePhone": "08123456789",
  "callbackUrl": "http://example.com/callback/",
  "notifyAddress": "example@gmail.com",
  "payeeBankName": "ICBC",
  "payeeDocumentType": "S",
  "transactionNote": "deserunt anim dolore dolor in",
  "bizModel": "CB",
  "expiryDays": "7",
  "payeePostCode": "0987",
  "payeeDocumentId": "58786868",
  "payeeDocumentDate": "2005-11-30",
  "payeeNationality": "ID",
  "payeeGender": "M",
  "payeeBirthCountry": "ID",
  "payeeBankCode": "NBCD",
  "state": "",
  "city": "ShangHai"
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
data	object	Yes		Response data.
data.tradeNo	string	Yes		PayerMax platform order number.
data.orderId	string	Yes		Merchant order ID.
bizCode	string	Yes		Response code, which indicates only whether the request is accepted. For disbursement result, please check the field “status” from callback or query API.
message	string	Yes		Response message.

Response Example: 1

成功示例

{
  "data": {
    "tradeNo": "20230428081551DO4429724600475529002",
    "orderId": "12re32wdds2342343454354r3123"
  },
  "bizCode": "0000",
  "message": "success"
}

Response Example: 2

异常示例

{
  "msg": "System is busy, please try again later.",
  "code": "SYSTEM_ERROR"
}