Get recurring payment

Retrieves one automatic payment by recurringPaymentId, including status, amounts, creditor context, and links back to the parent automatic payment request.

Use this after Create recurring payment to confirm settlement or rejection reasons.

GET/api/v1/automatic-payments/recurring-payments/{recurringPaymentId}

Get recurring payment details

Returns detailed information about a specific recurring (automatic) payment.

Auth: Bearer Token

Parâmetros de path

1 campo

recurringPaymentId●

pathstring

Identifier returned when the payment was created.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-payments/550e8400-e29b-41d4-a716-446655440000' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Recurring payment returned successfully.

Response body

object

dataobjectrequired
AutomaticPayment — see OpenAPI for every operational field.
- idstringrequired
  Automatic payment id.
- createDateTimestringrequired· date-time
  Creation timestamp.
- lastChangedDateTimestringrequired· date-time
  Last update timestamp.
- automaticPaymentRequestobjectrequired
  Parent AutomaticPaymentRequest linkage.
- recurringConsentIdstring
  Related consent id.
- statusstringrequired
  Statuses include `PENDENTE`, `REJEITADO`, `EM_PROCESSAMENTO`, `PAGO`, `EXPIRADO`, `CANCELADO`, `ERRO_NA_DETENTORA`, `ERRO`, `PROGRAMADO`, `AGUARDANDO_VALOR`.
- paymentCurrencystringrequired
  ISO currency (typically `BRL`).
- paymentAmountstring
  Monetary amount as string.
- dueDatestring
  Scheduled settlement date.
- dueDateTimestring· date-time
  Scheduled settlement instant.
- endToEndIdstring
  Pix end-to-end id.
- creditorIspbstringrequired
  Creditor ISPB.
- creditorIssuerstringrequired
  Creditor branch.
- creditorNumberstringrequired
  Creditor account number.
- creditorAccountTypestringrequired
  `CACC`, `SVGS`, or `TRAN`.
- creditorIdentitystringrequired
  Creditor document.
- cnpjInitiatorstringrequired
  Initiator CNPJ.
- localInstrumentstringrequired
  `MANU`, `DICT`, or `INIC`.
- remittanceInformationstring
  Remittance text.
- rejectionReasonstring
  Populated when status is rejected.
- isRetryAllowedbooleanrequired
  Whether Pix retry rules allow another attempt.
messagestring
Response message.
typestring
Envelope type.

200 · Recurring payment returned successfully.

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createDateTime": "2026-05-02T08:00:00Z",
    "lastChangedDateTime": "2026-05-02T08:01:00Z",
    "automaticPaymentRequest": {
      "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1"
    },
    "recurringConsentId": "urn:consent:abc123",
    "status": "PAGO",
    "paymentCurrency": "BRL",
    "paymentAmount": "1500.50",
    "dueDate": "2026-05-02",
    "creditorIspb": "12345678",
    "creditorIssuer": "0001",
    "creditorNumber": "1234567890",
    "creditorAccountType": "CACC",
    "creditorIdentity": "12345678000195",
    "cnpjInitiator": "37663090000100",
    "localInstrument": "DICT",
    "isRetryAllowed": true
  },
  "message": "",
  "type": "success"
}