Documentação/Referência da API

API REFERENCE

Cancelar pagamento

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

Cancelar pagamento

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

ParameterTypeDescriçãoObrigatório
data.trade_idstringYabandPay订单编号✓

Esta API cancela pedidos de pagamento, incluindo pedidos não pagos, pagos e autorizados com sucesso.

Se ainda não tiver recebido o resultado final do pagamento da YabandPay (sucesso ou falha), ou se quiser encerrar um pedido de pagamento, chame esta API para cancelá-lo.

Dica

  1. Limite de tempo: os pedidos de pagamento só podem ser cancelados dentro do período especificado, desde o início da transação até 00:30 do dia seguinte (dia T+1, 00:30), horário da Europa Central.
  1. Restrição de valor: o cancelamento deve abranger o valor total. Não há suporte para cancelamento parcial.
  1. Restrição para reembolso: um pedido de pagamento não pode ser cancelado se já tiver sido realizada qualquer operação de reembolso.
  1. Liquidação e taxas: pedidos de pagamento cancelados não são compensados nem liquidados, e a YabandPay não cobra taxas de transação.
ParâmetroTipoDescriçãoObrigatório
userStringConta de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CancelPaymentObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
trade_idStringNúmero do pedido YabandPayObrigatório

Signature example:

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

"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&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.CancelPayment",
	"time": 1546588959,
	"data": {
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
    }
}

Response example:

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

Additional information:

Response result:
  1. Se o cancelamento for bem-sucedido, "status": true será retornado.
  2. Se o cancelamento falhar, "status": false será retornado.

Chame Order Query para verificar o status do pedido. Se o status do pedido state for cancelled, o cancelamento foi bem-sucedido.

Response codes:
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