Initiate Payout

Disbursement Request API is required for outbound payments.

PayerMax supports payment methods in over 150 countries worldwide. Each payment method may require different fields. Before integrating, please refer to the Payment Method List to confirm the payment method you are connecting to.

1.Interaction Process

2.Integration Steps

(1) Download the [Disbursement Application Template and Filling Instructions] below and collect user withdrawal elements on your app or website.

Note:

Please refer [Disbursement Application Template and Filling Instructions] for detailed requirements for account information.

(2) Refer to the [Disbursement Application Template and Filling Instructions] "Fill in rule" sheet and fill in the required parameters (pink background) to build the API parameters.

For example, according to the template, the payeeInfo.document.documentId of the BANK_TRANSFER withdrawal method in Brazil (BR) is required, and this field must be input when the API is requested.

(3) Payment is irrevocable and cannot be withdrawn once initiated.

3.Order Idempotency Verification

When the merchant submits a payment request, the order number submitted must be guaranteed to be unique.

If PayerMax identifies a merchant requesting the same order number, it will respond code=ORDER_REPEAT and the current status of the order.

4.Interface Parameters

For details, please refer to Disbursement Request API.

5. Order Response

5.1 Order Successful Response

When code = APPLY_SUCCESS and msg = Success. in the response, the request is successful, but it does not necessarily mean the transaction is successful. The transaction status must be determined by the status field in the data body. For more information, please refer to Disbursement Request API.

5.2 Order Failure Response

5.2.1 Server Request Limitation

When initiating a payment request, you may encounter the following error codes of the "Server Request Limitation" category:

Category	Errorcode	Error Message	Remark
Server Request Limitation	REQ_TIME_OVER_TIME	requestTime effective in two minutes	The request time deviates from the server by more than 2 minutes. Please check the "requestTime" and retry.
	ILLEGAL_IP_REQUEST	illegal ip request	The requesting IP needs to be added to the whitelist, please contact PayerMax.
	TOO_MANY_REQUEST	Exceed request limitation, please retry later	The interface concurrent limit has been triggered. Please try again later.

5.2.2 Merchant Configuration Verification

When initiating a payment request, you may encounter the following error codes of the "Merchant Configuration Verification" category:

Category	Subcategory	Errorcode	Error Message	Remark
Merchant Configuration Verification	Signature/Key Configuration Verification	MERCHANT_APP_INVALID	Signature key is not configured.	The secret key is not configured. Please configure the key as soon as possible.
		SIGN_VERIFY_FAILED	The signature verify failed.	Signature verification failed, please check the key/signature logic.
	Contract Availability Verification	CONTRACT_INVALID	Merchant has not signed the contract or payment methods.	The contract has not been signed or the payment method has not been activated. Please check the contract status.
		MERCHANT_INVALID	The merchant has been offline.	The merchant has been offline. If you have any questions, please contact PayerMax.

5.2.3 Order Information Receiving

When initiating a payment request, you may encounter the following error codes of the "Order Information Receiving" category:

Category	Subcategory	Errorcode	Error Message	Remark
Order Information Receiving	Request Parameter Verification	PARAMS_INVALID	The {field} is incorrect.	Please refer to the "Disbursement Application Template and Filling Specifications" to view the field rules.
		PARAMS_INVALID	The {field} is incorrect，you should fill {?}	Please refer to the "Disbursement Application Template and Filling Specifications" to view the field rules.
		ORDER_REPEAT	The order number repeat.	The order number is repeated, please modify it and retry
	Other Exceptions	SYSTEM_ERROR	System is busy, Please try again later.	System exception, please check the order status, if the order fails, please retry