---
updatedAt: 2026-09-17T16:31:23.000Z
agentTools:
  projectIndex: https://docs.dlocal.com/llms.txt
---

# Get enrollment

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Payins",
    "version": "2.1"
  },
  "servers": [
    {
      "url": "https://api.dlocal.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "X-Date",
        "in": "header",
        "x-default": ""
      },
      "sec1": {
        "type": "apiKey",
        "name": "X-Login",
        "in": "header",
        "x-default": ""
      },
      "sec2": {
        "type": "apiKey",
        "name": "X-Trans-Key",
        "in": "header",
        "x-default": ""
      },
      "sec3": {
        "type": "apiKey",
        "name": "Content-Type",
        "in": "header",
        "x-default": "application/json"
      },
      "sec4": {
        "type": "apiKey",
        "name": "X-Version",
        "in": "header",
        "x-default": "2.1"
      },
      "sec5": {
        "type": "apiKey",
        "name": "User-Agent",
        "in": "header",
        "x-default": ""
      },
      "sec6": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": [],
      "sec2": [],
      "sec3": [],
      "sec4": [],
      "sec5": [],
      "sec6": []
    }
  ],
  "paths": {
    "/enrollments/{id}": {
      "get": {
        "tags": [
          "Enrollments"
        ],
        "summary": "Get enrollment",
        "description": "Retrieve information about an existing enrollment by its dLocal enrollment ID.",
        "operationId": "get-enrollment",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The dLocal enrollment ID (e.g., `E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4`).",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Enrollment details retrieved successfully.",
            "content": {
              "application/json": {
                "examples": {
                  "Active MERCHANT_SUBSCRIPTION enrollment": {
                    "value": {
                      "id": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4",
                      "external_id": "31231jj224",
                      "currency": "BRL",
                      "country": "BR",
                      "type": "MERCHANT_SUBSCRIPTION",
                      "description": "Pix Automatico - Monthly subscription - Variable amount",
                      "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_detail": "The enrollment is active.",
                      "status_code": "200",
                      "notification_url": "http://merchantsite.com/notifications"
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "dLocal enrollment ID.",
                      "example": "E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4"
                    },
                    "external_id": {
                      "type": "string",
                      "description": "Merchant-defined enrollment identifier.",
                      "example": "31231jj224"
                    },
                    "currency": {
                      "type": "string",
                      "example": "BRL"
                    },
                    "country": {
                      "type": "string",
                      "example": "BR"
                    },
                    "type": {
                      "type": "string",
                      "description": "Enrollment type: `ON_DEMAND` or `MERCHANT_SUBSCRIPTION`.",
                      "example": "MERCHANT_SUBSCRIPTION"
                    },
                    "description": {
                      "type": "string",
                      "example": "Pix Automatico - Monthly subscription"
                    },
                    "payment_method_id": {
                      "type": "string",
                      "example": "XA"
                    },
                    "payment_method_flow": {
                      "type": "string",
                      "example": "DIRECT"
                    },
                    "payment_method_type": {
                      "type": "string",
                      "example": "TICKET"
                    },
                    "subscription": {
                      "type": "object",
                      "description": "Subscription settings. Present for `MERCHANT_SUBSCRIPTION` type.",
                      "properties": {
                        "start_date": {
                          "type": "string",
                          "example": "2024-12-01"
                        },
                        "end_date": {
                          "type": "string",
                          "example": "2025-12-01"
                        },
                        "frequency": {
                          "type": "string",
                          "example": "MONTHLY"
                        },
                        "amount": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "example": "VARIABLE"
                            },
                            "value": {
                              "type": "number",
                              "description": "Fixed charge amount. Present when type is `FIXED`."
                            },
                            "min_value": {
                              "type": "number",
                              "description": "Minimum enrollment limit. Present when type is `VARIABLE`.",
                              "example": 300
                            }
                          }
                        }
                      }
                    },
                    "created_date": {
                      "type": "string",
                      "description": "Enrollment creation timestamp (ISO 8601).",
                      "example": "2024-07-26T20:37:20.000+0000"
                    },
                    "status": {
                      "type": "string",
                      "description": "Enrollment status: `PENDING`, `ACTIVE`, `REJECTED`, `CANCELLED`, `EXPIRED`.",
                      "example": "ACTIVE"
                    },
                    "status_code": {
                      "type": "string",
                      "description": "Enrollment status code. See status codes table in the enrollment guide.",
                      "example": "200"
                    },
                    "status_detail": {
                      "type": "string",
                      "example": "The enrollment is active."
                    },
                    "notification_url": {
                      "type": "string",
                      "example": "http://merchantsite.com/notifications"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "shell",
              "code": "curl -X GET \\\n   -H 'X-Date: {X-Date}' \\\n   -H 'X-Login: {X-Login}' \\\n   -H 'X-Trans-Key: {X-Trans-Key}' \\\n   -H 'X-Version: 2.1' \\\n   -H 'Authorization: V2-HMAC-SHA256, Signature: {Signature}' \\\n   https://api.dlocal.com/enrollments/E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4"
            }
          ],
          "samples-languages": [
            "shell"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```