Paytend api
API docs by Redocly

Paytend BaaS IBAN

Paytend BaaS Core API Product Documentation

1. Introduction

Paytend BaaS Core API is the core banking interface of Paytend BaaS (Banking as a Service), which provides services for various financial institutions, PSP (payment service provider), EMI (electronic money issuer), PI (payment institution), Fintech, etc. . The API is designed to simplify the provision of financial services, including bank account access and management.

2. Main functions

2.1 Onboarding of bank account (onboarding)

Quick Internet access process: Paytend BaaS Core API can quickly help customers open Paytend IBAN accounts, simplify the Internet access process, and reduce the difficulty of Internet access.

2.2 Manage Paytend IBAN account

  • Comprehensive Account Management: The API provides comprehensive account management capabilities, allowing customers to easily manage their Paytend IBAN accounts, including but not limited to the following features:
    • Check account balance
    • View account transaction history
    • Transfer and payment functions
    • Collection management
    • Transaction confirmation and status updates
    • Collection management
    • Transaction confirmation and status updates

3. Use cases

Paytend BaaS Core API is suitable for a variety of usage scenarios, including but not limited to the following:

  • Financial institutions: Allow traditional banks or financial institutions to integrate Paytend BaaS services to provide more flexible and convenient banking services.
  • PSP and EMI: Provide account management and payment functions for payment service providers and e-money issuers to enhance customer experience.
  • Fintech companies: Help Fintech innovators create and manage bank accounts more easily, thereby providing various financial solutions.

4. Access and integration

Detailed access and integration guide will be provided in Paytend BaaS official documentation, including information such as API endpoints, authentication, request examples, and response examples.

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 Documents required for user registration:

Personal users:

  • Identity document

    • Nationality EEA: ID card or passport
    • Nationality Chinese: ID card and passport
    • Nationality others: Passport

  • Face Recognition Photo

    If your nationality is not in the EEA, but your residence address is in the EEA, you need to upload an EEA residence permit or EEA address certificate

Corporate users:

  • Legal person information:

    • Identity document
      • ID card or passport
    • Face Recognition Photo

  • Corporation information:

    • Certificate of incorporation
    • Articles of association
    • Business Registration Certificate (required for HK companies)

4.4 Main interface calling process：

  • Verify mobile number

    The mobile phone number is the unique identifier of the customer in the Paytend system. This step verifies the uniqueness of the mobile phone number. Paytend will send a verification code to this mobile phone number, and submit the verification code in the next step. (This step is optional.)

  • Create user （Create individual user/ Create corporation user）

  • Upload supporting documents

    Paytend supports two methods of uploading files.

    • Directly push the verification results of Sumsub and Verify
    • Upload files directly.

  • Questionnaire(Individual questionnaire/Corporation questionnaire)

5. Security

Paytend BaaS Core API attaches great importance to data security and adopts industry-standard encryption and security measures to protect customers' sensitive information. Detailed security information will be provided in the official documentation.

Account Management Interface

Query user information

Request Body schema: application/json
required

request

required
object (UserInquery_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 (UserResponse)
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 cities

Request Body schema: application/json
required

request

required
object (Cities_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 (CitiesResponse)
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 user fees

Request Body schema: application/json
required

request

required
object (UserID_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 (UserFeesResponse)
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 user upgrade fee

Request Body schema: application/json
required

request

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.

bizData
object

Request business data
Encrypted by AES, the key is randomKey.

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 (UpgradeFeeResponse)
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
{
  • "requestId": "stringstringstringstringstringst",
  • "partnerId": "stringstringstr",
  • "randomKey": "string",
  • "bizData": { },
  • "signType": "string",
  • "signature": "string",
  • "version": "string"
}

Response samples

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

Query account information

Request Body schema: application/json
required

request

required
object (UserID_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 (AccountsResponse)
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"
}

Account Opening Interface

Verify mobile number

The mobile phone number is the unique identifier of the customer in the Paytend system. This step verifies the uniqueness of the mobile phone number. Paytend will send a verification code to this mobile phone number, and submit the verification code in the next step. This step is optional.

Request Body schema: application/json
required

request

required
object (VerificationCode_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"
}

Create individual user

Request Body schema: application/json
required

request

required
object (Individual_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 (RegisterResponse)
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"
}

Create corporation user

Request Body schema: application/json
required

request

required
object (Corporation_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 (RegisterResponse)
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

Special interface, No need to sign bizData, Maximum upload supported is 2M.

Request Body schema: application/json
required

request

required
object (File_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"
}

Individual questionnaire

Request Body schema: application/json
required

request

required
object (IndividualQuestionnaire_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"
}

Corporation questionnaire

Request Body schema: application/json
required

request

required
object (CorporationQuestionnaire_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"
}

Submit transfer order information

Request Body schema: application/json
required

request

required
object (TransferOrderRequest_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 transfer order file

Special interface, No need to sign bizData, Maximum upload supported is 2M.

Request Body schema: application/json
required

request

required
object (TransferOrderFile_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"
}

Webhook Interface

Account opening notification

When the account is successfully opened, 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:

  • 'Fund deposit notification' in 'Paytend Funding Notification API'
  • 'Account opening notification' in 'Paytend BaaS Core API'
  • 'User status change notification' in 'Paytend BaaS Core API'
  • 'User upgrade notification' in 'Paytend BaaS Core API'
  • 'Transfer order notification' in 'Paytend BaaS Core API'
  • 'Payment failure notification' in 'Paytend Payout API'

This interface field 'notifyType' is fixed to 1.

Request Body schema: application/json
required

notify

required
object (IBANAccount)
partnerId
required
string

Assigned by paytend.

notifyType
required
string


1. Account opening notification
2. Fund deposit notification
3. User status change notification
4. Payment failure notification
6. User upgrade notification
8. Transfer order notification

randomKey
string

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

signature
required
string

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

signType
required
string

Fixed value RSA.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "content": {
    },
  • "partnerId": "string",
  • "notifyType": "string",
  • "randomKey": "string",
  • "signature": "string",
  • "signType": "string",
  • "version": "string"
}

Response samples

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

Transfer order notification

When a transaction triggers an transfer order, 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:

  • 'Fund deposit notification' in 'Paytend Funding Notification API'
  • 'Account opening notification' in 'Paytend BaaS Core API'
  • 'User status change notification' in 'Paytend BaaS Core API'
  • 'User upgrade notification' in 'Paytend BaaS Core API'
  • 'Transfer order notification' in 'Paytend BaaS Core API'
  • 'Payment failure notification' in 'Paytend Payout API'

This interface field 'notifyType' is fixed to 8.

Request Body schema: application/json
required

notify

required
object (TransferOrderNotification_Context)
partnerId
required
string

Assigned by paytend.

notifyType
required
string


1. Account opening notification
2. Fund deposit notification
3. User status change notification
4. Payment failure notification
6. User upgrade notification
8. Transfer order notification

randomKey
string

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

signature
required
string

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

signType
required
string

Fixed value RSA.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "content": {
    },
  • "partnerId": "string",
  • "notifyType": "string",
  • "randomKey": "string",
  • "signature": "string",
  • "signType": "string",
  • "version": "string"
}

Response samples

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

User status change notification

When the audit status or user status changes, 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:

  • 'Fund deposit notification' in 'Paytend Funding Notification API'
  • 'Account opening notification' in 'Paytend BaaS Core API'
  • 'User status change notification' in 'Paytend BaaS Core API'
  • 'User upgrade notification' in 'Paytend BaaS Core API'
  • 'Transfer order notification' in 'Paytend BaaS Core API'
  • 'Payment failure notification' in 'Paytend Payout API'

This interface field 'notifyType' is fixed to 3.

Request Body schema: application/json
required

notify

required
object (AccountStatusChangeNotification_Context)
partnerId
required
string

Assigned by paytend.

notifyType
required
string


1. Account opening notification
2. Fund deposit notification
3. User status change notification
4. Payment failure notification
6. User upgrade notification
8. Transfer order notification

randomKey
string

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

signature
required
string

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

signType
required
string

Fixed value RSA.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "content": {
    },
  • "partnerId": "string",
  • "notifyType": "string",
  • "randomKey": "string",
  • "signature": "string",
  • "signType": "string",
  • "version": "string"
}

Response samples

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

User upgrade notification

When a user is upgraded from a junior user to a standard user (only a paid upgrade), 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:

  • 'Fund deposit notification' in 'Paytend Funding Notification API'
  • 'Account opening notification' in 'Paytend BaaS Core API'
  • 'User status change notification' in 'Paytend BaaS Core API'
  • 'User upgrade notification' in 'Paytend BaaS Core API'
  • 'Transfer order notification' in 'Paytend BaaS Core API'
  • 'Payment failure notification' in 'Paytend Payout API'

This interface field 'notifyType' is fixed to 6.

Request Body schema: application/json
required

notify

required
object (AccountUpgradeNotification_Content)
partnerId
required
string

Assigned by paytend.

notifyType
required
string


1. Account opening notification
2. Fund deposit notification
3. User status change notification
4. Payment failure notification
6. User upgrade notification
8. Transfer order notification

randomKey
string

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

signature
required
string

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

signType
required
string

Fixed value RSA.

version
required
string

Fixed value 2.0.

Responses

Response Schema: application/json
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

Content type
application/json
{
  • "content": {
    },
  • "partnerId": "string",
  • "notifyType": "string",
  • "randomKey": "string",
  • "signature": "string",
  • "signType": "string",
  • "version": "string"
}

Response samples

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