Documentación/Referencia de API

API REFERENCE

Cancelar pago

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

Cancelar pago

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

Request parameters1

Required fields first

取消支付

trade_idRequiredstringdata.trade_idYabandPay订单编号

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

Parámetros

ParameterTypeDescripciónObligatorio
data.trade_idstringYabandPay订单编号✓

Esta API cancela pedidos de pago, incluidos los no pagados, los pagados y los autorizados correctamente.

Si no ha recibido el resultado final del pago de YabandPay (correcto o fallido) o desea cerrar un pedido de pago, llame a esta API para cancelarlo.

Consejo

  1. Límite de tiempo: los pedidos de pago solo pueden cancelarse dentro del plazo especificado, desde el inicio de la transacción hasta 00:30 del día siguiente (T+1 day 00:30), Central European time.
  1. Restricción de importe: la cancelación debe ser por el importe total. No se admiten cancelaciones parciales.
  1. Restricción de reembolso: no se puede cancelar un pedido de pago si ya se ha realizado algún reembolso.
  1. Liquidación y comesiones: los pedidos de pago cancelados no se compensan ni liquidan, y YabandPay no cobra comesiones por transacción.
ParámetroTipoDescripciónObligatorio
userStringCuenta de cajero UIDObligatorio
signStringSignatureObligatorio
methodStringv3.CancelPaymentObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
trade_idStringNúmero de pedido de YabandPayObligatorio

Ejemplo de firma:

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

"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=YOUR_CASHIER_UID"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

{
    "user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CancelPayment",
	"time": 1546588959,
	"data": {
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
    }
}

Ejemplo de respuesta:

{
    "status": true,
    "code": "200",
    "data": {
        "type": "payment",
        "user": "YOUR_CASHIER_UID",
        "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. Si la cancelación se realiza correctamente, se devuelve "status": true es returned.
  2. Si la cancelación falla, se devuelve "status": false es returned.

Call Consulta de pedido para comprobar el estado del pedido. Si el estado del pedido state es cancelled, la cancelación se realizó correctamente.

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