Pular para o conteúdo

Create recurring consent

Creates an Automatic Pix recurring consent (Open Finance automatic product — not Sweeping). Send either an existing paymentRequestId or a full recurringConsent so the platform creates a payment request for you.

On 201 Created, persist data.id (poll Get payment request), data.consentId (use as recurringConsentId on Create recurring payment), and redirect the payer to data.redirectUrl.

The recurringConsent.redirectUri (when you send it) is where the account holder returns after consent — it must be allow-listed for your sub-tenant.

POST/api/v1/automatic-payments/recurring-consents

Create recurring consent

Creates a recurring consent for automatic payments and returns redirectUrl, id, and consentId.

Auth: Bearer Token

Headers

2 campos
subTenantId●
headerstring

Subtenant under which the consent is created.

User-Agent●
headerstring

Initiator application user agent (required by OpenAPI).

Request body

4 campos
organisationId●
bodystring

Organisation id from Get registered participants.

authorisationServerId●
bodystring

Authorisation server id from Get registered participants.

paymentRequestId
bodystring

Optional existing automatic payment request id when you are not sending `recurringConsent`.

recurringConsent
bodyobject

Consent payload when the API must create a payment request for you. Omit when `paymentRequestId` is sent.

loggedUser●
bodyobject

Logged payer identity at the initiator.

document●
bodyobject
identification●
bodystring
rel●
bodystring
businessEntity
bodyobject

Required when the logged user is a legal entity (`CNPJ`).

document●
bodyobject
identification●
bodystring
rel●
bodystring
redirectUri
bodystring

Allow-listed HTTPS URI after holder authorisation.

creditors●
bodyarray<object>

Receiving parties. Each item is an object with `personType`, `cpfCnpj`, and `name`.

personType●
bodystring
cpfCnpj●
bodystring
name●
bodystring
additionalInformation●
bodystring

Payer-facing note for the consent.

debtorAccount
bodyobject

Debtor account known at initiation (optional). If omitted, the holder supplies account details during authorisation.

ispb●
bodystring
issuer●
bodystring
number●
bodystring
accountType●
bodystring
recurringConfiguration●
bodyobject

Send the **`automatic`** branch for Automatic Pix.

automatic●
bodyobject

Matches `#/components/schemas/Automatic`.

contractId●
bodystring
fixedAmount●
bodystring
maximumVariableAmount●
bodystring
interval●
bodystring

Billing interval (for example `SEMANAL`, `MENSAL`).

contractDebtor●
bodyobject

Customer responsible for the contract.

name●
bodystring
document●
bodyobject

Contract debtor identity document.

identification●
bodystring
rel●
bodystring
firstPayment●
bodyobject
type●
bodystring
date●
bodystring
currency●
bodystring
amount●
bodystring
remittanceInformation●
bodystring
creditorAccount●
bodyobject
ispb●
bodystring
issuer●
bodystring
number●
bodystring
accountType●
bodystring
minimumVariableAmount●
bodystring
isRetryAccepted●
bodyboolean
referenceStartDate●
bodystring · date-time

Anchor for billing cycles — see Automatic Pix guide.

useOverdraftLimit●
bodyboolean
curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-consents' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --header 'User-Agent: MyApp/1.0 (https://example.com)' \
  --data '{
  "organisationId": "74e929d9-33b6-4d85-8ba7-c146c867a817",
  "authorisationServerId": "c8f0bf49-4744-4933-8960-7add6e590841",
  "paymentRequestId": "550e8400-e29b-41d4-a716-446655440000",
  "recurringConsent": {
    "loggedUser": {
      "document": {
        "identification": "76109277673",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "43053510000130",
        "rel": "CNPJ"
      }
    },
    "redirectUri": "https://your-app.example.com/automatic-pix/callback",
    "creditors": [
      {
        "personType": "PESSOA_JURIDICA",
        "cpfCnpj": "27653779000109",
        "name": "Instituto Gioia de Esporte"
      }
    ],
    "additionalInformation": "Automatic Pix — streaming subscription",
    "debtorAccount": {
      "ispb": "12345678",
      "issuer": "1774",
      "number": "1234567890",
      "accountType": "CACC"
    },
    "recurringConfiguration": {
      "automatic": {
        "contractId": "546sd4a",
        "fixedAmount": "300.01",
        "maximumVariableAmount": "500.00",
        "interval": "SEMANAL",
        "contractDebtor": {
          "name": "Alice Silva",
          "document": {
            "identification": "76109277673",
            "rel": "CPF"
          }
        },
        "firstPayment": {
          "type": "PIX",
          "date": "2026-01-15",
          "currency": "BRL",
          "amount": "1333.01",
          "remittanceInformation": "First subscription payment",
          "creditorAccount": {
            "ispb": "99999004",
            "issuer": "0001",
            "number": "11188222",
            "accountType": "SVGS"
          }
        },
        "minimumVariableAmount": "10.00",
        "isRetryAccepted": true,
        "referenceStartDate": "2026-01-01T00:00:00Z",
        "useOverdraftLimit": false
      }
    }
  }
}'

Response

201Recurring consent created successfully.
Response body
object
  • dataobjectrequired
    • idstringrequired

      Automatic payment request id — use as `{automaticPaymentsRequestId}` on GET payment request.

    • consentIdstringrequired

      Consent identifier — use as `recurringConsentId` on create recurring payment.

    • redirectUrlstringrequired

      URL where the payer completes authentication at the account holder.

  • messagestring

    Response message.

  • typestring

    Envelope type (for example `success`).

201 · Recurring consent created successfully.
{
  "data": {
    "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1",
    "consentId": "urn:consent:abc123",
    "redirectUrl": "https://holder.example.com/authorize?request=xyz"
  },
  "message": "",
  "type": "success"
}

Next steps