Create enrollment

Creates a new enrollment to enable recurring payments for a payer. Use this endpoint for enrollments without an initial payment.

Enrollment with an initial payment: Use POST /payments and include an enrollment object in the request body.

Enrollment types:

  • ON_DEMAND: Merchant initiates recurring payments at any time, with no frequency or amount restrictions.
  • MERCHANT_SUBSCRIPTION: Merchant initiates recurring payments based on defined subscription settings (frequency, amount, dates).
Responses

{
  "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
Loading…
Response
Choose an example:
application/json