Cancelation requested by merchant

This service allows merchants to cancel an active enrollment.

Example request

URL Selector with Opacity

Post

Production URL Sandbox URL

curl -X POST \
   -H 'X-Date: {X-Date}' \
   -H 'X-Login: {X-Login}' \
   -H 'X-Trans-Key: {X-Trans-Key}' \
   -H 'Content-Type: application/json' \
   -H 'X-Version: 2.1' \
   -H 'User-Agent: MerchantTest / 1.0 ' \
   -H 'Authorization: V2-HMAC-SHA256, Signature: {Signature}' \
   https://api.dlocal.com/enrollments/E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4/cancel

{
   "enrollment": {
       "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4",
       "external_id": "31231jj224"
   },
   "status": "CANCELLED",
   "status_detail": "The enrollment was cancelled",
   "status_code": "400"
}

Request params

Path param	Required	Type	Description
`id`	Yes	String	Enrollment ID to be canceled.

Cancelation notified by the processor/payment network

The cancelation of enrollment can be notified to dLocal by the local processors or other stakeholders of the payment network, for example, when the user cancels it directly through their online banking. In such cases, dLocal will cancel the enrollment on its platform and notify the merchant that the enrollment has been canceled.

{
  "enrollment": {
      "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca1",
      "external_id": "31231jj221"
  },
  "status": "CANCELLED",
  "status_detail": "Enrollment cancelled by user",
  "status_code": "401"
}