Create a deposit order

	Deposit amount rules
Deposit channel	Minimum single transaction	Maximum single transaction
CASHIER	100	50,000
UPI	100	50,000

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

03f7cd24b7c3cf26aad23c15eb7b36a8ed35d9964d03d1e96da6214c855dd29c32

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1704334484607

X-API-SIGNATURE

string

required

signature

Example:

3046022100bb4818ddbe977ea24ef6eba575819bffaeb7eb2a559cc3a4eb40d96397081982022100806178e43002e7376881f1e108abb2ed3cfc0d9d830cf73a80bf5b1e2db8848f

Body Params application/json

amount

string

Amount

required

currency

string

Currency

required

Fixed to fill in INR

customerAccountNumber

string | null

User bank card

optional

customerContact

string | null

User mobile phone

optional

customerEmail

string | null

User email

optional

customerName

string | null

User name

optional

mchNo

string

Merchant number

required

mchOrderNo

string

Merchant order number

required

notifyUrl

string

Result notification address

required

returnUrl

string | null

Cashier return page

optional

wayCode

string

Payment method code

required

Fixed fill in UPI

Example

{
    "amount": "100",
    "currency": "INR",
    "customerAccountNumber": "123456789",
    "customerContact": "9123456789",
    "customerEmail": "g762646676@126.com",
    "customerName": "DW",
    "mchNo": "M1688443660",
    "mchOrderNo": "YN220221122000000733",
    "notifyUrl": "https://payment-test.tarspay.com/notify",
    "returnUrl": "",
    "wayCode": "UPI"
}

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: 03f7cd24b7c3cf26aad23c15eb7b36a8ed35d9964d03d1e96da6214c855dd29c32' \
--header 'X-API-NONCE: 1704334484607' \
--header 'X-API-SIGNATURE: 3046022100bb4818ddbe977ea24ef6eba575819bffaeb7eb2a559cc3a4eb40d96397081982022100806178e43002e7376881f1e108abb2ed3cfc0d9d830cf73a80bf5b1e2db8848f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "100",
    "currency": "INR",
    "customerAccountNumber": "123456789",
    "customerContact": "9123456789",
    "customerEmail": "g762646676@126.com",
    "customerName": "DW",
    "mchNo": "M1688443660",
    "mchOrderNo": "YN220221122000000733",
    "notifyUrl": "https://payment-test.tarspay.com/notify",
    "returnUrl": "",
    "wayCode": "UPI"
}'

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

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed as INR

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

payDataType

string

Payment Mode

required

payurl - Payment Counter; Non-payurl - Merchant Self-built Payment Counter

payData

string

Payment Data

required

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Payment Counter Address

required

For payment counter order mode, return this link to the frontend

payWays

object

required

msg

string

Response Description

required

sign

string

required

Example

{
    "code": 0,
    "data": {
        "amount": "100",
        "countryCode": "in",
        "currency": "INR",
        "customerContact": "9123456789",
        "mchOrderNo": "YN220221122000000733",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742731237818892289",
        "payUrl": "https://payment-test.tarspay.com/#/order/in/P1742731237818892289",
        "payWays": {
            "UPI": [
                {
                    "countryCode": "in",
                    "createdAt": 0,
                    "id": 20,
                    "payWay": "UPI",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/upi.svg",
                    "payWayType": "UPI",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        }
    },
    "msg": "SUCCESS",
    "sign": "3046022100d848b8f671f8716e47ff0ae017f23ea18f3475d306662b890d684235f2516d2b022100a89cbadc21e37ff579a4e02fcc7ae5f85741406f11c44dcb1efec6c4c49586cd"
}

Create a deposit order

Limit information#

Request

Request samples

Responses

Limit information