Create enrollment

Body Params
string
required
string
required
string
required
string
enum
required
Allowed:
string
string
required
string
enum
required
Allowed:
payer
object
required
subscription
object
string
string
device
object
Responses

payment_method_flow:

  • REDIRECT: returns a redirect_url.
  • DIRECT: returns a ticket object (QR code/copy-paste code) for applicable payment methods.

Webhook notifications

Once the enrollment is processed, dLocal sends an asynchronous notification to the notification_url provided in the request.

Enrollment approved

{
  "id": "E-664388-3bcb6f88-9e71-4d90-a0e3-751971a5e5d8",
  "external_id": "31231jj224",
  "currency": "BRL",
  "country": "BR",
  "type": "MERCHANT_SUBSCRIPTION",
  "payment_method_id": "XA",
  "payment_method_flow": "REDIRECT",
  "payment_method_type": "TICKET",
  "created_date": "2024-07-26T20:37:20.000+0000",
  "approved_date": "2024-07-26T20:38:10.000+0000",
  "status": "ACTIVE",
  "status_detail": "The enrollment is active.",
  "status_code": "200",
  "notification_url": "http://merchantsite.com/notifications"
}

Enrollment rejected

{
  "id": "E-664388-3bcb6f88-9e71-4d90-a0e3-751971a5e5d8",
  "external_id": "31231jj224",
  "currency": "BRL",
  "country": "BR",
  "type": "MERCHANT_SUBSCRIPTION",
  "payment_method_id": "XA",
  "payment_method_flow": "REDIRECT",
  "payment_method_type": "TICKET",
  "created_date": "2024-07-26T20:37:20.000+0000",
  "status": "REJECTED",
  "status_detail": "The enrollment is rejected.",
  "status_code": "300",
  "notification_url": "http://merchantsite.com/notifications"
}

Enrollment statuses

StatusStatus codeDescription
PENDING100The enrollment is awaiting user authorization, or a cancellation is being processed by the bank.
ACTIVE200The enrollment is active and ready for recurring payments.
REJECTED300The enrollment was not authorized or was rejected.
CANCELLED400The enrollment was cancelled by the merchant.
CANCELLED401The enrollment was cancelled by the user directly through their home banking.

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json