Get enrollment details

This service allows merchants to retrieve information about an existing biometric enrollment, including its current status, creation date, and associated details.

This functionality is useful for:

Checking enrollment status before processing payments
General enrollment management and monitoring
Troubleshooting enrollment-related issues

Example request

URL Selector with Opacity

GET

Production URL Sandbox URL

curl -X GET \
   -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

{
  "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4",
  "external_id": "31231jj223",
  "currency": "BRL",
  "country": "BR",
  "type": "ON_DEMAND",
  "description": "Pix Biometrics enrollment",
  "payment_method_id": "XV",
  "payment_method_flow": "REDIRECT",
  "payment_method_type": "TICKET",
  "created_date": "2024-07-26T20:37:20.000+0000",
  "status": "PENDING",
  "status_detail": "The enrollment is pending.",
  "status_code": "100",
  "notification_url": "http://merchantsite.com/notifications"
}

{
  "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4",
  "external_id": "31231jj223",
  "currency": "BRL",
  "country": "BR",
  "type": "ON_DEMAND",
  "description": "Pix Biometrics enrollment",
  "payment_method_id": "XV",
  "payment_method_flow": "REDIRECT",
  "payment_method_type": "TICKET",
  "created_date": "2024-07-26T20:37:20.000+0000",
  "status": "ACTIVE",
  "status_detail": "The enrollment is active.",
  "status_code": "100",
  "notification_url": "http://merchantsite.com/notifications"
}

Path params

Field	Type	Description
`enrollment.id`	String	Enrollment ID provided by dLocal, used to identify the specific biometric enrollment.