Payout Inquiry

Request URL

https://{{gateway_domain}}/pg/v2/payout/query

Request Parameters

HTTP Method

POST

HTTP Header

Field	Data Type	Length Limit	Required	Description
Content-Type	String	N/A	YES	This field value only supports application/json.
Accept	String	N/A	YES	This field value only supports application/json.
Authorization	String		YES	Authorization: {type} {credentials}, refer to the Signature specifications section for details.

HTTP Body

Field	Data Type	Length Limit	Required	Description
merchantTradeNo	String	50	Choose one between merchantTradeNo and payoutNo	Merchant order number
payoutNo	String	32	Choose one between merchantTradeNo and payoutNo

Response Data

HTTP Header

Field	Data Type	Required	Description
Content-Type	String	YES	This field value only supports application/json.
Authorization	String	YES	Authorization: {type} {credentials}, refer to the Signature specifications section for details.

HTTP Body

Field	Data Type	Required	Description
code	String	YES	Refer to the response code table
errorMessage	String	NO
data	JSON Object	NO

Description of the data field

Field	Data Type	Required	Description
payoutNo	String	YES	The payout number generated by the payment platform.
merchantTradeNo	String	YES	The order number generated by the merchant.
amount	String	YES	The amount of the order.
currency	String	YES	The currency of the order.
totalFee	String	YES	Payout service fee.
status	String	YES	See order status for details.
rrn	String	NO	Reference Retrieval Number, depends on the channel's response.
merchantAttach	String	NO	When using this field in a payout request, it will be returned exactly as is during order inquiry.
createdTime	String	YES	Order creation time (local time with timezone).
paidTime	String	YES	Order paid time (local time with timezone). Returns null if payout is not successful.
errorCode	String	NO	Payout failed code, e.g. Payout.Common.Rejected.
errorInfo	String	NO	Payout failed message.

Examples

Request

curl https://{{gateway_domain}}/pg/v2/payout/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "merchantTradeNo": "MTOU-0211",
  "payoutNo": ""
}'

Response

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "payoutNo": "20240426192048100800062197000010",
        "merchantTradeNo": "MTOU-0211",
        "amount": "1.00",
        "currency": "INR",
        "totalFee": "0.00",
        "status": "PENDING",
        "rrn": "123456789",
        "merchantAttach": "merchant attach",
        "createdTime": "2024-04-26T19:20:53+08:00",
        "paidTime": "2024-04-26T19:21:28+08:00",
        "errorCode": "Payout.Common.Rejected",
        "errorInfo": ""
    }
}

Payout Status

Status	Description
PENDING	Pending Processing
PROCESSING	In Progress
PAID	Payout Successful
FAILURE	Payout Failed
REVERSED	Payout Reversed
CANCELLED	Payout Canceled