Paytend api
API docs by Redocly

Paytend BaaS Issuing Cards

Paytend BaaS Issuing Cards Product Documentation

1. Introduction

Paytend BaaS Issuing Cards API is the core bank card issuance interface of Paytend BaaS service. The main goal of the API is to support customers such as financial institutions, payment service providers (PSPs), electronic money issuers (EMIs), payment institutions (PIs) and Fintech to complete card application, card account opening, card activation and card payment for Paytend bank cards. Management and other key operations. In addition, it also supports physical card express services, card replacement, card cancellation, and card replacement registration.

2. Main functions

The Paytend BaaS Issuing Cards API provides a range of features that enable customers to easily manage the card issuance process, including but not limited to the following features:

2.1 Card application

  • Quick Card Application: Enables a fast and convenient bank card application process, including collection of necessary customer information and KYC (Know Your Customer) verification.

2.2 Card account opening

  • Card Account Creation: Assist in creating a Paytend bank card account to ensure a smooth card account opening process.

2.3 Card activation

  • Card Activation: Supports card activation, ensuring customers can use their cards immediately after receiving them.

2.4 Card management

  • Comprehensive Card Management: Provides comprehensive card management functions to enable customers to easily manage their bank cards, including but not limited to the following functions:
    • Card inquiries and status updates
    • Quota management
    • Transaction history query
    • PIN change

2.5 Physical card express delivery

  • Physical Card Express Service: Supports the express delivery of bank cards to ensure that customers can obtain physical cards when needed.

2.6 Card replacement, card cancellation, card replacement registration

  • Card Replacement: Assist customers in replacing bank cards.
  • Card Cancellation: Supports the cancellation operation of bank cards so that customers can stop using specific cards.
  • Card replacement registration: Assist customers to register for replacement of lost or damaged cards.

3. Supported card types

Paytend BaaS Issuing Cards API supports the issuance of multiple card types, including but not limited to:

  • Mastercard
  • Visa
  • UnionPay
  • Discover
  • American Express (AM)

4. Access and documentation

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. Customers can access according to the documentation 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 Precautions:

Cardholder ID: EEA region supports passport or ID card. Other regions only support passport. Cardholder photo information must correspond to cardholder information (idnoType).

4.4 Main interface calling process：

  • Card Holder

    • Create cardholder.
    • Upload supporting documents.
    • Query cardholder.

  • Bank Card

    • Buy unactivated cards in bulk
      • Activation.
    • API orders, shipped by Paytend
      • Apply.
      • Query apply result.
      • Query card information.(optional)
      • Activation. The physical card activates the card through this API, and the virtual card will be automatically activated when the order is shipped.

5. Security

Data security is crucial in the financial sector. Paytend BaaS Issuing Cards 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.

Card Interface

Apply card

Request Body schema: application/json
required

request

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

Active card

Request Body schema: application/json
required

request

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

Topup

Request Body schema: application/json
required

request

required
object (Topup_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 (TopupResponse)
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"
}

Replace card

After the card replacement is successful, the old card will be frozen and the new card will be automatically activated using the old card holder information.
The balance of the old card will be reset within 24 hoursDuring this period, please ensure the card is safe to avoid user losses.

Request Body schema: application/json
required

request

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

Report loss

Request Body schema: application/json
required

request

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

Cancel report loss

Request Body schema: application/json
required

request

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

Retrieve password

Request Body schema: application/json
required

request

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

Query apply result

Request Body schema: application/json
required

request

required
object (CardApplyResult_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 (CardApplyResponse)
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 card information

Request Body schema: application/json
required

request

required
object (CardID_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 (CardInfoResponse)
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 topup result

Request Body schema: application/json
required

request

required
object (TopupResult_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 (TopupResultResponse)
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 (CardTransactions_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 (CardTransactionsResponse)
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 authorization transactions

Request Body schema: application/json
required

request

required
object (AuthorizeTrans_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 (AuthorizeTransResponse)
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 card design style

Request Body schema: application/json
required

commonRequest

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 (SKUResponse)
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 card balance

Request Body schema: application/json
required

commonRequest

required
object (CardID_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 (CardBalanceResponse)
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 card overdue monthly fee

Request Body schema: application/json
required

commonRequest

required
object (CardID_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 (CardBalanceResponse)
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"
}

Cardholder Interface

Create cardholder

Request Body schema: application/json
required

request

required
object (CreateHolder_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 (HolderResponse)
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 cardholder

Request Body schema: application/json
required

request

required
object (CardHolderUpdate_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 (HolderResponse)
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 cardholder

Request Body schema: application/json
required

request

required
object (GetHolder_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 (HolderResponse)
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

Maximum upload supported is 2M.

Request Body schema: application/json
required

request

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

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"
}

Partner Interface

Query partner balance

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: */*
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (PartnerBalanceResponse)
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"
}

Query partner topup information

Request Body schema: application/json
required

request

required
object (PartnerTopup_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: */*
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (PartnerTopupResponse)
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"
}

Query partner transaction information

Request Body schema: application/json
required

request

required
object (PartnerTransaction_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: */*
respCode
required
string

Response code.
00. success
Others. failure

respMsg
string

Response message.

object (PartnerTransactionResponse)
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"
}

Webhook Interface

Cardholder audit result notification

When the cardholder review is completed,the partner will be notified.
The partner is required to provide a callback URL.

Request Body schema: application/json
required

notify

required
object (CardHolderResult)
notifyType
required
string


1. Card transaction notification
2. Cardholder audit result notification
3. Apply card result notification

partnerId
required
string

Assigned by paytend.

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: */*
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

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

Apply card result notification

When the application card is approved,the partner will be notified.
The partner is required to provide a callback URL.

Request Body schema: application/json
required

notify

required
object (CardApplyResponse)
notifyType
required
string


1. Card transaction notification
2. Cardholder audit result notification
3. Apply card result notification

partnerId
required
string

Assigned by paytend.

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: */*
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

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

Card transaction notification

When a settlement transaction or authorization transaction occurs on the card,the partner will be notified.
The partner is required to provide a callback URL.

Request Body schema: application/json
required

notify

required
object (TransactionNotification)
notifyType
required
string


1. Card transaction notification
2. Cardholder audit result notification
3. Apply card result notification

partnerId
required
string

Assigned by paytend.

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: */*
msg
string

Business description.

status
string

Status.
00 success
other failed

Request samples

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