TarsPay_EN

Query withdraw order

POST

/api/payOutInfo

Request

Header Params

X-API-KEY

string

required

the public key applied for by the merchant backend

Example:

0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0

X-API-NONCE

string

required

the system timestamp is accurate to milliseconds

Example:

1704250498993

X-API-SIGNAT URE

string

required

signature

Example:

304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d631436 8470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6

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": "M1688443982",
  "mchOrderNo": "YN7220230300929"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/payOutInfo' \
--header 'X-API-KEY:  0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0' \
--header 'X-API-NONCE:  1704250498993' \
--header 'X-API-SIGNAT URE: 304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d631436 8470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6' \
--header 'Content-Type: application/json' \
--data-raw '{
  "mchNo": "M1688443982",
  "mchOrderNo": "YN7220230300929"
}'

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

PKR

required

fee

string

Handling fee

required

mchOrderNo

string

Merchant order number

required

state

integer

Order Status

required

0, 1-Paying 2-Success 3-Failure 5-Refund 8-Rejection(equals Failure)

msg

string

required

Example

{
    "code": 0,
    "data": {
        "currency": "PKR",
        "fee": "0",
        "mchNo": "M1688443982",
        "mchOrderNo": "YN7220230300929",
        "orderAmount": "100",
        "payAmount": "0",
        "payOrderId": "P1681112064487976961",
        "state": 1
    },
    "msg": "SUCCESS"
}

Create withdraw order

Query balance