v1

latestOpenAPI 3.1.02026-07-245361280.3 KB

Cancel pending payment

Cancel pending payments for alternative payment methods (APMs).

post/payments/{payment_id}/cancel

Path parameters

payment_idstring required

The payment ID.

Response

200

idstring

amountinteger

currencystring

payment_method_idstring

payment_method_typestring

payment_method_flowstring

countrystring

created_datestring

statusstring

status_detailstring

status_codestring

order_idstring

descriptionstring

notification_urlstring

Example response

{
  "id": "D-4-f1500792-7527-4a0e-86ef-3a9472b63f21",
  "amount": 1000,
  "currency": "MXN",
  "payment_method_id": "OX",
  "payment_method_type": "TICKET",
  "payment_method_flow": "DIRECT",
  "country": "MX",
  "created_date": "2020-09-14T19:11:48.000+0000",
  "status": "CANCELLED",
  "status_detail": "The payment was cancelled.",
  "status_code": "400",
  "order_id": "23796c17-2cc5-4fbb-86b5-10da0859a282",
  "description": "test",
  "notification_url": "http://conductor.sandbox.internal/robot-server/rest/generic/notification/new"
}