Pular para o conteúdo

Create recurring payment

Creates one automatic payment under an approved recurring consent. Use the consentId returned by Create recurring consent as recurringConsentId.

Ensure Get payment request shows consentStatus: AUTHORISED before calling this endpoint for the first payment after consent.

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

Create recurring payment

Creates a recurring payment with full payment details and returns the created automatic payment.

Auth: Bearer Token

Headers

1 campo
subTenantId●
headerstring

Subtenant initiating the payment.

Request body

5 campos
recurringConsentId●
bodystring

`consentId` from Create recurring consent (201).

date●
bodystring

Payment date (`YYYY-MM-DD`).

payment●
bodyobject

Payment amount and currency for this leg.

amount●
bodystring

Payment amount (decimal string, for example `0.01`).

currency●
bodystring

ISO currency code (typically `BRL`).

creditorAccount●
bodyobject

Creditor account for settlement.

ispb●
bodystring
issuer●
bodystring
number●
bodystring
accountType●
bodystring
remittanceInformation●
bodystring

Pix remittance information / purpose text.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-payments' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --data '{
  "recurringConsentId": "urn:consent:abc123",
  "date": "2026-05-02",
  "payment": {
    "amount": "0.01",
    "currency": "BRL"
  },
  "creditorAccount": {
    "ispb": "12345678",
    "issuer": "0001",
    "number": "1234567890",
    "accountType": "CACC"
  },
  "remittanceInformation": "Automatic Pix recurring payment"
}'

Response

201Recurring payment created successfully.
Response body
object
  • dataobjectrequired

    AutomaticPayment — see OpenAPI for the full field list.

    • idstringrequired

      Automatic payment id.

    • statusstringrequired

      Payment status such as `PENDENTE`, `EM_PROCESSAMENTO`, `PAGO`, `REJEITADO`, `ERRO`, etc.

    • paymentCurrencystringrequired

      Currency code (typically `BRL`).

    • paymentAmountstring

      Settled or instructed amount when available.

    • dueDatestring

      Settlement date (`YYYY-MM-DD`).

    • endToEndIdstring

      Pix end-to-end identifier when assigned.

    • recurringConsentIdstring

      Linked consent id.

    • automaticPaymentRequestobjectrequired

      Parent request summary — see OpenAPI.

  • messagestring

    Response message.

  • typestring

    Envelope type.

201 · Recurring payment created successfully.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "EM_PROCESSAMENTO",
    "paymentCurrency": "BRL",
    "paymentAmount": "0.01",
    "dueDate": "2026-05-02",
    "recurringConsentId": "urn:consent:abc123",
    "automaticPaymentRequest": {
      "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1"
    }
  },
  "message": "",
  "type": "success"
}

Next steps