Documentação/Referência da API

API REFERENCE

Reversão da transação

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

Reversão da transação

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

Request parameters3

Required fields first

交易撤销

tidRequiredstringdata.tid设备的TID
trade_idRequiredstringdata.trade_idYabandPay订单编号
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

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

Parâmetros

ParameterTypeDescriçãoObrigatório
data.tidstring设备的TID✓
data.trade_idstringYabandPay订单编号✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Aplica-se a pagamentos presenciais com POS

Esta API inicia a reversão de transações bem-sucedidas pela nuvem.

A reversão de transação só é compatível com transações do dia atual e permite apenas reversões totais.

Para reversões parciais ou transações de dias anteriores, use a API de reembolso.

Depois que uma instrução de reversão é enviada, o terminal POS mostra em tempo real o processo e o resultado final, para que o estabelecimento e os usuários possam confirmar imediatamente o status da reversão. Para fazer uma reversão silenciosa (sem exibir o processo no terminal POS), use a API Cancel Payment.

Antes de chamar esta API, confirme que o dispositivo POS está online e disponível para que a instrução de reversão possa ser entregue e processada com sucesso.

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

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

ParâmetroTipoDescriçãoObrigatório
userStringTID do dispositivoObrigatório
signStringSignatureObrigatório
methodStringv3.POSReversalObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
tidstringTID do dispositivoObrigatório
trade_idStringNúmero do pedido YabandPayObrigatório
request_idStringID de solicitação exclusivo; recomenda-se uma combinação de letras e números com pelo menos 24 caracteresObrigatório

Signature example:

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

 "method=v3.POSReversal&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&tid=T125119061&time=1555498137&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=T125119061" 

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

 {
  "user": "T125119061",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.POSReversal",
  "time": 1555498137,
  "data": {
   "tid": "T125119061",
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
    "request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"

  }
} 

Response example:

{
  "status": true,
  "code": "200",
  "data": {
        "type": "payment",
        "user": "T125119061",
        "amount": "0.10",
        "currency": "EUR",
        "trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
        "description": "YabandPay test",
        "order_id": "YOUR_ORDER_ID",
        "createDate": "1706771212",
        "demo": "test",
        "transaction_id": "",
        "state": "cancelled"
  },
  "message": ""} 

Additional information:

Response result:
  1. Uma solicitação bem-sucedida retorna "status": true.
  2. Uma solicitação malsucedida retorna "status": false.

Recomendamos fortemente usar tanto consultas de pedidos quanto notificações assíncronas para sincronizar e atualizar o status do pagamento e manter as informações atualizadas em tempo real.

Response codes:
StatusCodeMessage
true200
false-3001Required field is missing
false-3002duplicate request_id
false-4111Exceed cancel window
false-4112The transaction has been cleared cannot be cancelled
false-4114The trade_id does not exist
false-4115The transaction cannot be cancelled
false-4116The transaction has been cancelled
false-4117The transaction has been Expired