Documentación/Referencia de API

API REFERENCE

Obtener trade_id

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

Obtener trade_id

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

Request parameters1

Required fields first

获取trade_id

invoice_idRequiredstringdata.invoice_id单号

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

Parámetros

ParameterTypeDescripciónObligatorio
data.invoice_idstring单号✓

Obtener trade_id using invoice_id.

Consejo

Después de una transacción correcta, utilice esta API para obtener el correspondiente trade_id para operaciones posteriores, como aumentar o reducir la autorización, capturar fondos, consultar, revertir o reembolsar.

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

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

ParámetroTipoDescripciónObligatorio
userStringCuenta de cajero UIDObligatorio
signStringSignatureObligatorio
methodStringv3.GetTradeIdObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
invoice_idStringOrder numberObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

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

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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

Información adicional:

Resultado de la respuesta:
  1. A successful request returns "status": true.

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

Códigos de respuesta:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-4006Order number does not exist

Notes

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