Documentation/API Reference

API REFERENCE

Get trade_id

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Get trade_id

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters1

Required fields first

Get trade_id

invoice_idRequiredstringdata.invoice_idOrder number

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Get trade_id using invoice_id.

Tip

After a successful transaction, use this API to obtain the corresponding trade_id for subsequent operations, such as increasing or decreasing authorization, capture, querying, reversal, or refund.

API URL (production): https://mapi.yabandpay.com/Payments

API URL (test): https://acc-mapi.yabandpay.com/Payments

ParameterTypeDescriptionRequired
userStringCashier account UIDRequired
signStringSignatureRequired
methodStringv3.GetTradeIdRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
invoice_idStringOrder numberRequired

Signature example:

Sorted parameters concatenated into a URL-style query string

"invoice_id=1234567&method=v3.GetTradeId&time=1546588959&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.GetTradeId",
  "time": 1546588959,
  "data": {
    "invoice_id": "1234567"
  }
}

Response example:

{
  "status": true,
  "code": "200",
  "data": {
    "trade_id": "2312e8b0-8ed5-6a66-293e-29efc206c599"
  },
  "message": ""
}

Additional information:

Response result:
  1. A successful request returns "status": true.

  2. A failed request returns "status": false.

Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-4006Order number does not exist

Notes

trade_id is generally available approximately 1 minute after transaction completion.
If the error "Order number does not exist" is returned, wait approximately 1 minute before trying again.