API REFERENCE
Obter trade_id
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.invoice_id | string | 单号 | ✓ |
Obtenha trade_id usando invoice_id.
Dica
Após uma transação bem-sucedida, use esta API para obter o
trade_idcorrespondente 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âmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | Conta de caixa UID | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.GetTradeId | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| invoice_id | String | Número do pedido | Obrigató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:
- Uma solicitação bem-sucedida retorna "status": true.
- Uma solicitação malsucedida retorna "status": false.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -4006 | Order 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.
