TarsPay_EN

Query withdraw order

POST

/api/payOutInfo

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

02d6433f5bedc5bc35b0971b8acce048b2ad4bce74210bea1288a10f42b166e057

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1702279880267

X-API-SIGNATURE

string

required

signature

Example:

304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72

Body Params application/json

mchNo

string

Merchant number

required

payOrderId

string

Payment platform order number

optional

One of the payment platform order number and merchant order number is required

mchOrderNo

string

Merchant order number

optional

One of the payment platform order number and merchant order number is required

Example

{
  "mchNo": "M1688454487",
  "mchOrderNo": "YN35320230300880"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/payOutInfo' \
--header 'X-API-KEY: 02d6433f5bedc5bc35b0971b8acce048b2ad4bce74210bea1288a10f42b166e057' \
--header 'X-API-NONCE: 1702279880267' \
--header 'X-API-SIGNATURE: 304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72' \
--header 'Content-Type: application/json' \
--data-raw '{
  "mchNo": "M1688454487",
  "mchOrderNo": "YN35320230300880"
}'

Responses

🟢200成功

application/json

Body

code

integer

required

data

object

required

mchNo

string

Merchant number

required

payOrderId

string

Payment platform order number

required

orderAmount

string

Order amount

required

payAmount

string

Payment amount

required

currency

string

VND

required

fee

string

Handling fee

required

mchOrderNo

string

Merchant order number

required

state

integer

Order Status

required

2-Success 3-Failure 5-Refund 6-Timeout and User Has Not Paid 9-Partial Payment

msg

string

required

Example

{
    "code": 0,
    "data": {
        "currency": "VND",
        "fee": "0",
        "mchNo": "M1688454487",
        "mchOrderNo": "YN35320230300880",
        "orderAmount": "1000000",
        "payAmount": "0",
        "payOrderId": "P1742369451135565825",
        "state": 6
    },
    "msg": "SUCCESS"
}

Create withdraw order

Query balance