Paytend Payout API supports the fastest real-time remittance of funds from your Paytend account to more than 90 countries and regions around the world. Funds will be credited in local currency and support multiple currencies, providing you with convenient fund remittance services. This feature allows you to easily batch process international remittances and payments, making payments to partners, suppliers, and globally more convenient and efficient.
Paytend Payout API provides the following main features:
Paytend Payout API is suitable for a variety of usage scenarios, including but not limited to the following:
Detailed access and integration documentation will be provided on the Paytend official website, including information such as API endpoints, authentication, request examples, and response examples. Customers can access according to the documentation and customize the integration according to their needs.
Communication Method
Communicate using HTTPS, the message format is JSON
Character Set
Messages are uniformly encoded in UTF-8
bizData:
Encrypted by randomly generated AES KEY.randomKey:
AES KEY is encrypted by Paytend public key.signature:
The signature source string is composed of all non-empty field contents except the signature field, sorted according to the ASCII code of the message field, and connected with the "&" symbol in the manner of "field name = field value".{
"randomKey":"qeM/mnvepEv5MFe7n77brQ==",
"requestId":"20231025102930718",
"signType":"RSA",
"bizData":{
"mobile":"13261402222",
"type":"1"
},
"partnerId":"888666000100260",
"version":"2.0"
}
The signature source string signature is as follows. The signature source string uses the partner RSA private key signature to generate the signature.
bizData={"mobile":"8613261402222","type":"1"}&partnerId=888666000100260&randomKey=gNx86vc1yttHs8ZWOf7+5g==&requestId=20231025095118321&signType=RSA&version=2.0
SHA256withRSA
.117
.128
.signature
field in the request data is generated by the Partner RSA private key signature.signature
field in the response data is generated by the Paytend RSA private key signature.randomKey
and bizData
plain text participate in the signature.Data security is crucial in the financial sector. Paytend Payout API uses advanced data encryption and security measures to ensure the protection of fund remittances and transaction information, complying with the security standards of the financial industry.
This interface is only applicable to Local payment.
request
object (Payer_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayerResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payerId": 0,
- "payerType": "s",
- "companyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "firstName": "string",
- "lastName": "string",
- "idno": "string",
- "idnoType": "string",
- "idCountry": "st",
- "birthday": "stringstri",
- "nationalityCode": "st",
- "mobile": "stringst",
- "occupation": "string",
- "address": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payerId": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
This interface is only applicable to Local payment.
request
object (Payer_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayerResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payerId": 0,
- "payerType": "s",
- "companyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "firstName": "string",
- "lastName": "string",
- "idno": "string",
- "idnoType": "string",
- "idCountry": "st",
- "birthday": "stringstri",
- "nationalityCode": "st",
- "mobile": "stringst",
- "occupation": "string",
- "address": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payerId": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
This interface is only applicable to Local payment.
request
object (PayerInqueryr_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayerInqueryResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payerId": 0,
- "payerType": "s",
- "idno": "string"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payerId": 0,
- "payerType": "s",
- "companyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "firstName": "string",
- "lastName": "string",
- "idno": "string",
- "idnoType": "string",
- "idCountry": "st",
- "birthday": "stringstri",
- "nationalityCode": "st",
- "mobile": "stringst",
- "occupation": "string",
- "address": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (Payee_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayeeResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payeeId": 0,
- "paymentType": 0,
- "currency": "str",
- "benAccountNum": "stringstringstri",
- "benAccountName": "string",
- "swiftPaymentBenInfo": {
- "intermediaryBankSWIFT": "string",
- "swiftCode": "stringst",
- "benAccountType": 0,
- "residenceAddress": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}, - "bankCode": "string"
}, - "localPaymentBenInfo": {
- "bankChannelId": "string",
- "bankCode": "string",
- "bankAccountType": "string",
- "benAccountType": 0,
- "address": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}, - "benCompanyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "taxId": "string",
- "benFirstName": "string",
- "benLastName": "string",
- "nationalityCode": "st",
- "idnoType": "st",
- "idno": "string",
- "idExpirationDate": "stringstri",
- "birthday": "stringstri",
- "mobile": "stringst"
}
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payeeId": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
This interface is only applicable to Local payment.
request
object (Payee_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayeeResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payeeId": 0,
- "paymentType": 0,
- "currency": "str",
- "benAccountNum": "stringstringstri",
- "benAccountName": "string",
- "swiftPaymentBenInfo": {
- "intermediaryBankSWIFT": "string",
- "swiftCode": "stringst",
- "benAccountType": 0,
- "residenceAddress": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}, - "bankCode": "string"
}, - "localPaymentBenInfo": {
- "bankChannelId": "string",
- "bankCode": "string",
- "bankAccountType": "string",
- "benAccountType": 0,
- "address": {
- "addressLine": "stringstri",
- "addressLine2": "stringstri",
- "cityCode": "string",
- "state": "stringstri",
- "postcode": "string",
- "countryCode": "st"
}, - "benCompanyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "taxId": "string",
- "benFirstName": "string",
- "benLastName": "string",
- "nationalityCode": "st",
- "idnoType": "st",
- "idno": "string",
- "idExpirationDate": "stringstri",
- "birthday": "stringstri",
- "mobile": "stringst"
}
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payeeId": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (PayeeInquery_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PayeeInqueryResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payeeId": 0,
- "benAccountNum": "stringstringstri",
- "currency": "str",
- "paymentType": 0,
- "bankChannelId": "string"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "payeeId": 0,
- "paymentType": 0,
- "currency": "str",
- "swiftCode": "stringst",
- "benAccountNum": "stringstringstri",
- "benAccountName": "string",
- "countryCode": "st",
- "cityCode": "string",
- "address": "stringstri",
- "postcode": "string",
- "bankCode": "string",
- "intermediaryBankSWIFT": "string",
- "benCompanyName": "string",
- "registrationNum": "string",
- "registrationDate": "stringstri",
- "taxId": "string",
- "benFirstName": "string",
- "benLastName": "string",
- "nationalityCode": "st",
- "idnoType": "st",
- "idno": "string",
- "idExpirationDate": "stringstri",
- "birthday": "stringstri",
- "mobile": "stringst",
- "bankAccountType": "string",
- "bankChannelId": "string"
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (Payment_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PaymentResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "tradeType": 0,
- "orderNo": "stringstringstri",
- "payAccountNum": "stringstringstri",
- "payeeId": 0,
- "payerId": 0,
- "benAccountNum": "stringstringstri",
- "feeMethod": 0,
- "localPaymentAmountType": 0,
- "amount": 0,
- "currency": "str",
- "reference": "string",
- "benRelationship": "string",
- "sourceFunds": "string",
- "payPurpose": "string"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "orderNo": "stringstringstri",
- "paymentCurrency": "stringstringstri",
- "paymentAmount": 16,
- "paymentFee": 16,
- "paymentTotalAmount": 16,
- "receivedCurrency": "stringstringstri",
- "receivedAmount": 16
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (OrderNo_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (PaymentResultResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "orderNo": "stringstringstri"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "resultCode": 0,
- "paymentCurrency": "stringstringstri",
- "resultMsg": "string",
- "orderNo": "string",
- "paymentAmount": 16,
- "payAccountNum": "string",
- "paymentFee": 16,
- "benAccountNum": "string",
- "paymentTotalAmount": 16,
- "benAccountName": "string",
- "receivedCurrency": "stringstringstri",
- "receivedAmount": 16,
- "feeMethod": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (ExchangeRate_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (ExchangeRateResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "payAccountNum": "stringstringstri",
- "currency": "str",
- "targetCurrency": "str",
- "targetCountry": "st"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "currency": "string",
- "targetCurrency": "string",
- "exchangeRate": "string",
- "exchangeRateId": "string"
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (Payout_Transactions_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (payout_queryTransactionsResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "accountNum": "stringstringstri",
- "currency": "str",
- "beginDate": "stringstri",
- "endDate": "stringstri",
- "tradeType": 0,
- "orderNo": "stringstringstri",
- "reference": "string",
- "start": "string",
- "maxResult": "string",
- "reconciliationDate": "string"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "total": "string",
- "tradeList": [
- {
- "transactionId": "string",
- "orderNo": "string",
- "accountNum": "string",
- "tradeType": 0,
- "tradeStatus": 0,
- "paymentType": 0,
- "currency": "string",
- "amount": 0,
- "fee": 0,
- "counterpartyAccountName": "string",
- "counterpartyAccountNum": "string",
- "counterpartyBankBic": "string",
- "counterpartyBankName": "string",
- "transDate": "string",
- "reconciliationDate": "string",
- "reference": "string",
- "exRate": "string",
- "targetCurrency": "string",
- "targetAmount": 0
}
]
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (OrderNo_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (IBANTransaction) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "orderNo": "stringstringstri"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "transactionId": "string",
- "orderNo": "string",
- "accountNum": "string",
- "tradeType": 0,
- "tradeStatus": 0,
- "paymentType": 0,
- "currency": "string",
- "amount": 0,
- "fee": 0,
- "counterpartyAccountName": "string",
- "counterpartyAccountNum": "string",
- "counterpartyBankBic": "string",
- "counterpartyBankName": "string",
- "transDate": "string",
- "reconciliationDate": "string",
- "reference": "string",
- "exRate": "string",
- "targetCurrency": "string",
- "targetAmount": 0
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
required | object (AccountBalance_BizData) |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (AccountBalanceResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "accountNum": "stringstringstri",
- "currency": "str"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "accountNum": "string",
- "accountName": "string",
- "currency": "string",
- "accountStatus": "string",
- "balance": 0,
- "availableBalance": 0,
- "freezeAmount": 0,
- "openDate": "string"
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (AccountNum_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (IBANAccount) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "accountNum": "stringstringstri"
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "userId": "string",
- "accountNum": "string",
- "accountName": "string",
- "currency": "string",
- "accountType": "string",
- "bic": "string",
- "bankName": "string",
- "bankAddress": "string",
- "openDate": "string"
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
request
object (OpenBanking_BizData) | |
requestId required | string = 32 characters Request serial number, globally unique. |
partnerId required | string = 15 characters Assigned by paytend. |
randomKey | string AES key |
signType required | string Fixed value RSA. |
signature | string Signed by partner RSA private key. |
version required | string Fixed value 2.0. |
respCode required | string Response code. |
respMsg | string Response message. |
object (OpenBankingQRCodeResponse) | |
randomKey | string AES key. |
signType required | string Fixed value RSA. |
signature | string Signed by paytend RSA private key. |
{- "bizData": {
- "accountNum": "string",
- "accountName": "string",
- "currency": "string",
- "bic": "string",
- "amount": 0,
- "reference": "string",
- "purpose": "stri",
- "remittance": "string",
- "information": "string",
- "width": 1,
- "height": 1
}, - "requestId": "stringstringstringstringstringst",
- "partnerId": "stringstringstr",
- "randomKey": "string",
- "signType": "string",
- "signature": "string",
- "version": "string"
}
{- "respCode": "string",
- "respMsg": "string",
- "respData": {
- "accountNum": "string",
- "suffix": "string",
- "qrCodeContent": "string"
}, - "randomKey": "string",
- "signType": "string",
- "signature": "string"
}
When payment fails and funds are returned, the partner will be notified.
The partner is required to provide a callback URL, which can be set through the interface 'Set callback URL' in 'Paytend Funding Notification API'.
The following interfaces share this URL:
This interface field 'notifyType' is fixed to 4.
notify
required | object (PaymentFailure_Context) |
partnerId required | string Assigned by paytend. |
notifyType required | string
|
randomKey | string AES key. |
signature required | string Signed by partner RSA private key. |
signType required | string Fixed value RSA. |
version required | string Fixed value 2.0. |
msg | string Business description. |
status | string Status. |
{- "content": {
- "payAccountNum": "string",
- "currency": "string",
- "orderNo": "string",
- "origOrderNo": "string",
- "amount": 0,
- "fee": 0,
- "payeeId": 0,
- "benAccountNum": "string",
- "benAccountName": "string",
- "resultCode": 0
}, - "partnerId": "string",
- "notifyType": "string",
- "randomKey": "string",
- "signature": "string",
- "signType": "string",
- "version": "string"
}
{- "msg": "string",
- "status": "string"
}