This process allows either the merchant or the user to invalidate an active biometric enrollment so it can no longer be used as a payment method.

If enabled, merchants can initiate the cancelation via API, while users can also cancel their enrollment through their Home Banking or mobile banking applications.

Once the enrollment is canceled, its status changes to CANCELLED, and no further recurring or subsequent payments can be processed using that enrollment.

Cancelation requested via API

This service allows merchants to cancel an active biometric enrollment.

Flow

Example request

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"
  },
  "status": "CANCELLED",
  "status_detail": "The enrollment token was cancelled",
  "status_code": "400"
}

Path params

Cancelation notified via Home Banking

Enrollment cancelation can be initiated by local processors or other payment network stakeholders, for example, when users cancel their biometric enrollment directly through their online banking platform.

In such cases, dLocal will cancel the enrollment on its platform and notify the merchant via webhook notification.

Flow

Notification

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