Get enrollment details

This endpoint allows merchants to retrieve information about an existing Pix subscription.

Merchants can use this service to query relevant details such as frequency, start and end dates, status, and other important information at any time.

Request example

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}' \
   -d '{body}'
   https://api.dlocal.com/enrollments/E-4-32e1218f-b6ec-3f21-13d5-50v12ere2ca4

{
    "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"
}