DLdlocal
Authorization

Cancel an authorization

Changed on

This service allows you to cancel an authorized transaction before it's captured.

post/payments/{authorization_id}/cancel

Request

  • Base URL
    https://api.dlocal.com
  • URL
    https://api.dlocal.com/payments/{authorization_id}/cancel
  • Auth
    API key in header X-Date and API key in header X-Login and API key in header X-Trans-Key and API key in header Content-Type and API key in header X-Version and API key in header User-Agent and API key in header Authorization

Path parameters

authorization_idstring required

The Authorization ID.

Response

200

idstring
amountnumber float
currencystring
payment_method_idstring
payment_method_typestring
payment_method_flowstring
countrystring
created_datestring
approved_datestring
statusstring
status_detailstring
status_codestring
order_idstring
notification_urlstring

Example response

{
  "id": "D-4-09f52dd0-5cfa-4b0e-a471-1608ea0dba24",
  "amount": 120,
  "currency": "USD",
  "payment_method_id": "CARD",
  "payment_method_type": "CARD",
  "payment_method_flow": "DIRECT",
  "country": "BR",
  "created_date": "2019-02-07T17:37:36.000+0000",
  "approved_date": "2019-02-07T17:37:36.000+0000",
  "status": "CANCELLED",
  "status_detail": "The payment was cancelled",
  "status_code": "400",
  "order_id": "be2fbac6-6114-44dc-a5f5-c4cdc38dda57",
  "notification_url": "http://conductor.sandbox.internal/robot-server/rest/generic/notification/new"
}

Changes

  • e31ec9de4008Revision changes
    • breaking

      the response's property type changed from integer to number, and format from no format to float for status

    • info

      api tag Authorization added