Documentación/Referencia de API

API REFERENCE

Cancelación de transacción

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

Cancelación de transacción

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

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

Se aplica a pagos presenciales con POS

Esta API inicia desde la nube la cancelación de pedidos impagados.

Esto cierra la pantalla de pago del terminal para que el sistema pueda iniciar una nueva solicitud de transacción.

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

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

ParámetroTipoDescripciónObligatorio
userStringTID del dispositivoObligatorio
signStringSignatureObligatorio
methodStringv3.POSCancelObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
tidstringTID del dispositivoObligatorio
trade_idStringNúmero de pedido de YabandPayObligatorio
request_idStringID de solicitud único; se recomienda una combinación de letras y números de al menos 24 caracteresObligatorio

Ejemplo de firma:

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

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

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

  }
} 

Ejemplo de respuesta:

{
  "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": ""} 

Información adicional:

Resultado de la respuesta:
  1. Una solicitud correcta devuelve "status": true.

  2. Una solicitud fallida devuelve "status": false.

Recomendamos encarecidamente utilizar tanto las consultas de pedidos como las notificaciones asíncronas para sincronizar y actualizar el estado del pago y mantener la información de pago precisa en tiempo real.

Códigos de respuesta:
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