Create a deposit order

POST

/api/pay/unifiedOrder

Quota Information

| |deposit amount limit rules| | |
| :---: | :---: | :---: |
| deposit channel | Minimum single transaction |Maximum single transaction |
| CASHIER | 10 | 50,000 |
| PIX | 10 | 50,000 |

Request

Header Params

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

Modified at 2025-04-23 08:11:59

Attachment Code Table

Query deposit order status

Create a deposit order

Quota Information#

Request

Request Code Samples

Responses

Quota Information