API REFERENCE
Consulta de reembolso
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.refund_id | string | YabandPay退款单号 | — |
| data.m_refund_id | string | 商户退款单号 | — |
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | Conta de caixa UID | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.QueryRefundOrder | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| refund_id | String | Número do pedido de reembolso YabandPay | Opcional (um deles deve ser informado) |
| m_refund_id | String | Número do pedido de reembolso do estabelecimento | Opcional (um deles deve ser informado) |
Signature example:
Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL
"method=v3.QueryRefundOrder&time=1728566835&refund_id=3841510a-4d18-4a61-808d-431a45006de2&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.QueryRefundOrder",
"time": 1728566835,
"data": {
"refund_id": "3841510a-4d18-4a61-808d-431a45006de2"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"transaction_id": "20240903153820059756",
"refund_id": "20240903154342497308",
"m_refund_id": null,
"refund_time": "1725349422",
"state": "refunded",
"refund_amount": "0.01",
"refund_currency": "EUR",
"refund_description": "gary",
"notify_url": "null",
"demo": "",
"settlement_refund_amount": "0.01",
"settlement_refund_currency": "EUR",
"merchant_cost": "0.1",
"yb_transaction_id": "c07859aa-3d12-69d4-ef2f-a9556d9c4d33"
},
"message": ""
}
Additional information:
Response result:
- Uma solicitação bem-sucedida retorna "status": true.
- Uma solicitação malsucedida retorna "status": false.
Refund status:
| Code | State | Message |
|---|---|---|
| 20 | to-be-approval | Awaiting administrator approval. |
| 21 | refund pending | The current balance is insufficient. The refund is submitted automatically when sufficient funds are available. |
| 22 | refund processing | The refund request has been submitted and is being processed by the system. |
| 23 | refunded | The refund has completed successfully. |
| 24 | refund failed | The refund failed. Please try again. |
| 25 | refund error | The refund failed. Please contact our online customer support. |
| 26 | refund cancelled | The refund order has been cancelled. |