Documentação/Referência da API

API REFERENCE

Obter trade_id

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

Obter 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

ParameterTypeDescriçãoObrigatório
data.invoice_idstring单号✓

Obtenha trade_id usando invoice_id.

Dica

Após uma transação bem-sucedida, use esta API para obter o trade_id correspondente para operações subsequentes, como aumentar ou diminuir a autorização, capturar, consultar, reverter ou reembolsar.

API URL (produção): https://mapi.yabandpay.com/Payments

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

ParâmetroTipoDescriçãoObrigatório
userStringConta de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.GetTradeIdObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
invoice_idStringNúmero do pedidoObrigatório

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

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

Sign stringA using secret_key

A assinatura resultante é:

"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. Uma solicitação bem-sucedida retorna "status": true.
  2. Uma solicitação malsucedida retorna "status": false.
Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-4006Order number does not exist

Observações

trade_id geralmente fica disponível aproximadamente 1 minuto após a conclusão da transação.
Se o erro "Order number does not exist" for retornado, aguarde aproximadamente 1 minuto antes de tentar novamente.