v1

latestOpenAPI 3.1.02026-07-245361280.3 KB

Get enrollment

Retrieve information about an existing enrollment by its dLocal enrollment ID.

get/enrollments/{id}

Path parameters

idstring required

The dLocal enrollment ID (e.g., E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4).

Response

Enrollment details retrieved successfully.

idstring

dLocal enrollment ID.

external_idstring

Merchant-defined enrollment identifier.

currencystring

countrystring

typestring

Enrollment type: ON_DEMAND or MERCHANT_SUBSCRIPTION.

descriptionstring

payment_method_idstring

payment_method_flowstring

payment_method_typestring

created_datestring

Enrollment creation timestamp (ISO 8601).

statusstring

Enrollment status: PENDING, ACTIVE, REJECTED, CANCELLED, EXPIRED.

status_codestring

Enrollment status code. See status codes table in the enrollment guide.

status_detailstring

notification_urlstring

Example response

{
  "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4",
  "external_id": "31231jj224",
  "currency": "BRL",
  "country": "BR",
  "type": "MERCHANT_SUBSCRIPTION",
  "description": "Pix Automatico - Monthly subscription",
  "payment_method_id": "XA",
  "payment_method_flow": "DIRECT",
  "payment_method_type": "TICKET",
  "subscription": {
    "start_date": "2024-12-01",
    "end_date": "2025-12-01",
    "frequency": "MONTHLY",
    "amount": {
      "type": "VARIABLE",
      "min_value": 300
    }
  },
  "created_date": "2024-07-26T20:37:20.000+0000",
  "status": "ACTIVE",
  "status_code": "200",
  "status_detail": "The enrollment is active.",
  "notification_url": "http://merchantsite.com/notifications"
}