Create a deposit order

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1702279880267

X-API-SIGNATURE

string

required

signature

Example:

304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72

Body Params application/json

amount

string

Amount

required

body

string

Product Description

required

currency

string

Currency

required

Fixed BRA

customerAccountNumber

string | null

User Bank Card

optional

customerContact

string | null

User Mobile Phone

optional

customerEmail

string | null

User Email

optional

customerName

string

User Name

required

Brazil policy adjustment This field must be true and required

mchNo

string

Merchant number

required

mchOrderNo

string

Merchant order number

required

notifyUrl

string

Result notification address

required

returnUrl

string | null

Cashier return page

optional

subject

string

Product title

required

accountTax

string | null

Tax number

optional

Tax number, personal subject is CPF, if filled in, it must be a correct CPF, the format is 11 digits string, otherwise the PIX code will not be generated

wayCode

string

Payment method code

required

CASHIER-Cashier mode PIX-Non-Cashier mode

Example

{
    "amount": "83",
    "body": "buy card",
    "currency": "BRA",
    "mchNo": "M123456",
    "customerName": "GDW",
    "mchOrderNo": "202201010001",
    "notifyUrl": "http://zbebcdlb.gm/rdcpxzitbx",
    "wayCode": "PIX",
    "subject": "test"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/pay/unifiedOrder' \
--header 'X-API-KEY: 02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe' \
--header 'X-API-NONCE: 1702279880267' \
--header 'X-API-SIGNATURE: 304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "83",
    "body": "buy card",
    "currency": "BRA",
    "mchNo": "M123456",
    "customerName": "GDW",
    "mchOrderNo": "202201010001",
    "notifyUrl": "http://zbebcdlb.gm/rdcpxzitbx",
    "wayCode": "PIX",
    "subject": "test"
}'

Responses

🟢200成功

application/json

Body

code

integer

Response Code

required

0 - Success, Non - 0 - Failure

data

object

Response Data

required

amount

string

Order Amount

required

body

string

Product Description

required

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed as BRA

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

payDataType

string

Payment Mode

required

payurl - Checkout Page, Non - payurl - Merchant Self - built Checkout Page

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Checkout Page Address

required

For checkout page order mode, return this link to the front - end; for non - checkout page mode, it is a QR code link

reference

string

Payment Details

required

Merchants can generate their own 2D payment codes based on this value; returned for non - checkout page mode

payWays

object

required

subject

string

Product Title

required

msg

string

Response Description

required

sign

string

required

Examples

Checkout success examplePIX Success Examples

{
    "code": 0,
    "data": {
        "amount": "20",
        "body": "Test",
        "countryCode": "br",
        "currency": "BRA",
        "customerContact": "13116709877",
        "mchOrderNo": "BX2023040000817",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742397641116069889",
        "payUrl": "https://payment.tpservice.pro/#/order/br/P1742397641116069889",
        "payWays": {
            "PIX": [
                {
                    "countryCode": "br",
                    "createdAt": 0,
                    "id": 69,
                    "payWay": "PIX",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/bank-danamon-vector-logo.png",
                    "payWayType": "PIX",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        },
        "subject": "GDW"
    },
    "msg": "SUCCESS",
    "sign": "3045022100e9a8d8e4b1dfce497eff59a1b616c3310faacdbf3975b7b560a346cb989ca0350220056cba967df503f4f3592fcecc19325ba93a2417020b49390919434cddaf1b81"
}

Create a deposit order

Quota Information#

Request

Request samples

Responses

Quota Information