Paytend api
API docs by Redocly

Paytend BaaS PF

Paytend BaaS PF API Product Documentation

1. Introduction

Paytend BaaS PF API is a bank card acquiring API interface for the Paytend BaaS service designed specifically for Paytend's Payment Facilitator (PF) service provider. The main goal of this API is to support PF service providers in providing payment acquiring services and provide key functions such as merchant onboarding and clearing management.

2. Main functions

2.1 Merchant Onboarding (network access)

  • Merchant network access process: Paytend BaaS PF API supports a fast merchant network access process, helping PF service providers to quickly set up a merchant identification (MID), so that merchants can provide payment and billing services. This feature includes:
    • Collection of merchant information
    • KYC (Know Your Customer) verification
    • Merchant account creation
    • Merchant configuration and settings

2.2 Liquidation management

  • Clearing Management: This API provides clearing management functions to help PF service providers effectively manage transaction clearing with merchants, including but not limited to the following functions:
    • Transaction recording and report generation
    • Setup of liquidation plan
    • Settlement processing
    • Fund settlement

3. PF common abilities

Paytend BaaS PF API not only provides the above main functions, but also supports a series of common Payment Facilitator capabilities to meet the needs of different PF service providers. These common capabilities include, but are not limited to:

  • Account splitting and settlement: Supports splitting and allocating payments to different merchants, as well as regular settlement of account payments.
  • Risk Management: Provide risk assessment tools to help PF service providers monitor and manage potential risks, such as fraud and irregular transactions.
  • Payment Gateway Integration: Integrate with various payment gateways and payment processors to provide a wide range of payment options.
  • Reporting and Analysis: Generate transaction reports and data analysis to help PF service providers monitor business performance and trends.

4. Access and documentation

The Paytend BaaS PF API provides detailed access and integration documentation, including information on API endpoints, authentication, request examples, and response examples. PF service providers can access according to the documents and customize the integration according to their needs.

4.1 Interface communication method

  • Communication Method

    Communicate using HTTPS, the message format is JSON

  • Character Set

    Messages are uniformly encoded in UTF-8

4.2 Signature verification field description

  • 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".
    • for example: Send SMS verification code to request data
{
  "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
  • Precautions
    • The signature algorithm of RSA is SHA256withRSA.
    • The maximum encrypted plaintext length of RSA is 117.
    • The maximum decryption ciphertext length of RSA is 128.
    • The signature field in the request data is generated by the Partner RSA private key signature.
    • The signature field in the response data is generated by the Paytend RSA private key signature.
    • randomKey and bizData plain text participate in the signature.
    • For specific implementation, please refer to the Sandbox demo in Support and Contact
    • When decrypting the returned data or verifying the signature, you need to first determine whether the field has a value. Some errors will not result in a signature, such as: The request field type is wrong.

4.3 Main interface calling process：

  • Merchant.
    • Create merchant.
    • Merchant Questionnaire.
    • Upload supporting documents.
    • Set settlement account.
    • Create merchant result notification.
    • Open merchant payment.
    • Open merchant payment result notification.
  • Settlement.
    • Withdrawal.
    • Query balance.
    • Query withdrawal result.
    • Query merchant account transactions.
    • Query transaction information.

5. Security

Data security is crucial in the financial sector. Paytend BaaS PF API uses advanced data encryption and security measures to ensure the protection of sensitive information. Detailed safety information will be included in the official documentation.

Merchant Interface

Create merchant

Request Body schema: application/json
required

request

object (MerchantInfo)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

respData
object

Business data.

randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": { },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Update merchant

Approved merchants are not allowed to update information..

Request Body schema: application/json
required

request

object (MerchantInfo)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

respData
object

Business data.

randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": { },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query merchant

Request Body schema: application/json
required

request

object (GetMerchant_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (MerchantResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Merchant questionnaire

Request Body schema: application/json
required

request

required
object (Questionnaire_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

respData
object

Business data.

randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": { },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Upload supporting documents

No encryption required, plain text transmission.

  • European countries: ID card and passport, choose one.
  • Required file type: 4(Registration Number),5(Equity description),11(Questionnaire file),1001(Shareholder certificate).
Request Body schema: application/json
required

request

required
object (UploadMerchantFile_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

respData
object

Business data.

randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": { },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Open merchant payment

Request Body schema: application/json
required

request

object (OpenPayment_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (OpenPaymentResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query opening merchant payment result

Request Body schema: application/json
required

request

object (PaymentResult_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (OpenPaymentResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query merchant static QR code link.

Request Body schema: application/json
required

request

object (MerchantID_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (MerchantQRCodeResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Settlement Interface

Set settlement account

Request Body schema: application/json
required

request

required
object (SettlementAccount)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

respData
object

Business data.

randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": { },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query settlement account

Request Body schema: application/json
required

request

object (MerchantID_BizData_1)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (SettlementResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Withdrawal

Request Body schema: application/json
required

request

required
object (Withdrawal_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (WithdrawalResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query withdrawal result

Request Body schema: application/json
required

request

required
object (WithdrawResult_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (WithdrawResultResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query merchant balance

Request Body schema: application/json
required

request

required
object (Balance_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (BalanceResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query merchant account transactions

Request Body schema: application/json
required

request

required
object (Settlement_Payment_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (PaymentResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Query transaction information

Request Body schema: application/json
required

request

required
object (PF_Transaction_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (TransactionResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Download settlement file

Request Body schema: application/json
required

request

required
object (SettlementFile_BizData)
requestId
required
string = 32 characters

Request serial number, globally unique.

partnerId
required
string = 15 characters

Assigned by paytend.

randomKey
string

AES key
Randomly generated, encrypted by paytend RSA public key.
When bizData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by partner RSA private key.
When the requested data format is incorrect, the signature may not exist.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (SettlementFileResponse)
randomKey
string

AES key.
Randomly generated, encrypted by partner RSA public key.
When respData exists, randomKey must exist.

signType
required
string

Fixed value RSA.

signature
string

Signed by paytend RSA private key.
When the requested data format is incorrect, the signature may not exist.

Request samples

Content type
application/json
{
  • "bizData": {
    },
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "respCode": "string",
  • "respMsg": "string",
  • "respData": {
    },
  • "randomKey": "string",
  • "signType": "string",
  • "signature": "string"
}

Webhook Interface

Create merchant result notification

The partner is required to provide a callback URL.

Request Body schema: application/json
required

openingNotification

partnerMerchantId
required
string [ 6 .. 15 ] characters

Partner merchant ID.
Assigned by partner,globally unique.

merchantId
required
string [ 6 .. 15 ] characters

Merchant ID.
Assigned by paytend,globally unique.

auditStatus
required
string

Audit status
See dictionary table for audit status (4.14.Audit status).

auditStatusMsg
required
string

Audit status description
If not empty, the audit rejection reason.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "partnerMerchantId": "string",
  • "merchantId": "string",
  • "auditStatus": "string",
  • "auditStatusMsg": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string",
  • "status": "string"
}

Open merchant payment result notification

The partner is required to provide a callback URL.

Request Body schema: application/json
required

notify

partnerMerchantId
required
string

Partner merchant ID.
Assigned by partner,globally unique.

channelType
required
integer <int32>

Channel type.
See dictionary table for channel type (4.6.Channel type).

businessType
required
integer <int32>

Business type.
See dictionary table for business type (4.7.Business type).

accessModeType
required
integer <int32>

Access mode type.
See dictionary table for access type (4.8.Access type).

  • Online. accessModeType is 1 and 2.
  • Offline. accessModeType is 3 and 4.
  • When channelType = 3,accessModeType is 2 and 4.
  • When channelType = 1 and businessType = 3,accessModeType is 5.
channelMCC
required
string

Channel MCC
See MCC list in Support and Contact.

channelMerchantId
string

Paytend assigned channel number.

settlementPeriod
required
string

Settlement period.

serviceStatus
required
string

Service status.
See dictionary table for service status (4.9.Service status).

returnMsg
required
string

Audit status description.
If not empty, the audit rejection reason.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "partnerMerchantId": "string",
  • "channelType": 0,
  • "businessType": 0,
  • "accessModeType": 0,
  • "channelMCC": "string",
  • "channelMerchantId": "string",
  • "settlementPeriod": "string",
  • "serviceStatus": "string",
  • "returnMsg": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string",
  • "status": "string"
}