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

Cabeçalhos

1 campo
subTenantId●
headerstring

Subtenant initiating the payment.

Corpo da requisição

12 campos
recurringConsentId●
bodystring

`consentId` from Create recurring consent (201).

date●
bodystring

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

payment●
bodyobject

Payment instruction — schedule is optional unless product requires it.

redirectUri●
bodystring

Allow-listed HTTPS URI related to this payment context.

value●
bodynumber

Amount in BRL.

creditor●
bodyobject

Receiving party.

name●
bodystring
personType●
bodystring
cpfCnpj●
bodystring
accountNumber●
bodystring
accountIssuer●
bodystring
accountPixKey●
bodystring
accountIspb●
bodystring
accountType●
bodystring
debitor
bodyobject

Optional debtor hints — see OpenAPI.

accountNumber●
bodystring
accountIssuer●
bodystring
accountIspb●
bodystring
accountType●
bodystring
details
bodystring

Human-readable payment description.

externalId
bodystring

Your correlation id.

cpfCnpj
bodystring

Debtor CPF/CNPJ digits.

schedule
bodyobject

Optional scheduler branch — required only for scheduled modalities per OpenAPI.

txId
bodyarray<[object Object]>

Optional transaction identifiers.

creditorAccount●
bodyobject

Creditor account for settlement.

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

Pix remittance information / purpose text.

cnpjInitiator●
bodystring

Initiator CNPJ (14 digits).

ibgeTownCode●
bodystring

IBGE municipality code.

authorisationFlow●
bodystring

Authorisation flow identifier (for example `HYBRID_FLOW`).

localInstrument●
bodystring

`MANU`, `DICT`, or `INIC` per arrangement rules.

document●
bodyobject

Payer document context.

identification●
bodystring
rel●
bodystring
originalRecurringPaymentId
bodystring

OpenAPI marks this as required, but the published `basic` example omits it. Send when your flow or the arrangement requires linkage to a prior leg; otherwise follow backend validation.

riskSignals●
bodyobject

Manual + automatic risk telemetry — all fields in `manual` are required by OpenAPI.

manual●
bodyobject
deviceId●
bodystring
isRootedDevice●
bodyboolean
screenBrightness●
bodynumber
elapsedTimeSinceBoot●
bodynumber
osVersion●
bodystring
userTimeZoneOffset●
bodystring
screenDimensions●
bodyobject
width●
bodynumber
height●
bodynumber
accountTenure●
bodystring
geolocation●
bodyobject
latitude●
bodynumber
longitude●
bodynumber
type●
bodystring
isCallInProgress●
bodyboolean
isDevModeEnabled●
bodyboolean
isMockGPS●
bodyboolean
isEmulated●
bodyboolean
isMonkeyRunner●
bodyboolean
isCharging●
bodyboolean
antennaInformation●
bodyboolean
isUsbConnected●
bodyboolean
integrity●
bodyobject
appRecognitionVerdict●
bodystring
deviceRecognitionVerdict●
bodystring
automatic●
bodyobject
lastLoginDateTime●
bodystring · date-time

Last time the payer interacted with your app.

pixKeyRegistrationDateTime●
bodystring · date-time

When the Pix key was registered with you (required when `localInstrument` is DICT or INIC).

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": {
    "redirectUri": "https://your-app.example.com/automatic-pix/payment-return",
    "value": 1500.5,
    "creditor": {
      "name": "Merchant Legal Name LTDA",
      "personType": "PESSOA_JURIDICA",
      "cpfCnpj": "12345678000195",
      "accountNumber": "1234567890",
      "accountIssuer": "0001",
      "accountPixKey": "pix@merchant.example.com",
      "accountIspb": "12345678",
      "accountType": "CACC"
    },
    "debitor": {
      "accountNumber": "9876543210",
      "accountIssuer": "0001",
      "accountIspb": "87654321",
      "accountType": "CACC"
    },
    "details": "Sweep transfer — payroll sweep",
    "externalId": "ext-payment-001",
    "cpfCnpj": "76109277673"
  },
  "creditorAccount": {
    "ispb": "12345678",
    "issuer": "0001",
    "number": "1234567890",
    "accountType": "CACC"
  },
  "remittanceInformation": "Automatic sweep payment",
  "cnpjInitiator": "37663090000100",
  "ibgeTownCode": "3550308",
  "authorisationFlow": "HYBRID_FLOW",
  "localInstrument": "DICT",
  "document": {
    "identification": "76109277673",
    "rel": "CPF"
  },
  "originalRecurringPaymentId": "E9040088820210128000800123873170",
  "riskSignals": {
    "manual": {
      "deviceId": "device-uuid-001",
      "isRootedDevice": false,
      "screenBrightness": 0.75,
      "elapsedTimeSinceBoot": 120000,
      "osVersion": "17.4.1",
      "userTimeZoneOffset": "-03",
      "screenDimensions": {
        "width": 390,
        "height": 844
      },
      "accountTenure": "PT720H",
      "geolocation": {
        "latitude": -23.55,
        "longitude": -46.63,
        "type": "COARSE"
      },
      "isCallInProgress": false,
      "isDevModeEnabled": false,
      "isMockGPS": false,
      "isEmulated": false,
      "isMonkeyRunner": false,
      "isCharging": true,
      "antennaInformation": true,
      "isUsbConnected": false,
      "integrity": {
        "appRecognitionVerdict": "PASS",
        "deviceRecognitionVerdict": "PASS"
      }
    },
    "automatic": {
      "lastLoginDateTime": "2026-05-01T11:00:00Z",
      "pixKeyRegistrationDateTime": "2025-01-10T08:00:00Z"
    }
  }
}'

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": "1500.50",
    "dueDate": "2026-05-02",
    "recurringConsentId": "urn:consent:abc123",
    "automaticPaymentRequest": {
      "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1"
    }
  },
  "message": "",
  "type": "success"
}

Next steps