Pular para o conteúdo

Get payment request

Returns a single automatic payment request by id. Use the id returned by Create recurring consent as the path automaticPaymentsRequestId.

Poll until data.consentStatus is AUTHORISED before calling Create recurring payment.

GET/api/v1/automatic-payments/request/{automaticPaymentsRequestId}

Get payment request details

Retrieves one automatic payment request including creditors, configurations, consent status, and linked payments.

Auth: Bearer Token

Parâmetros de path

1 campo
automaticPaymentsRequestId●
pathstring

Same value as `data.id` from Create recurring consent (201).

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/request/f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Payment request returned successfully.
Response body
object
  • dataobjectrequired

    AutomaticPaymentRequest — masked fields may omit sensitive data.

    • idstringrequired

      Automatic payment request id.

    • createDateTimestringrequired· date-time

      Creation timestamp.

    • lastChangedDateTimestringrequired· date-time

      Last update timestamp.

    • subTenantobjectrequired

      Nested sub-tenant context — see OpenAPI for full SubTenant schema.

    • consentIdstring

      Consent id from the payments domain.

    • loggedUserIdentitystringrequired

      Payer document linked to the request.

    • loggedUserTypestringrequired

      Document type for logged user (for example `CPF`).

    • businessIdentitystring

      Business document when applicable.

    • businessTypestring

      Business document type when applicable.

    • statusstringrequired

      Request lifecycle status: `PENDENTE`, `EM_PROCESSAMENTO`, `CONSUMIDO`, `EXPIRADO`, `CANCELADO`, `ERRO_NA_DETENTORA`, `ERRO`.

    • consentStatusstringrequired

      Open Finance consent status: `AWAITING_AUTHORISATION`, `PARTIALLY_ACCEPTED`, `AUTHORISED`, `REJECTED`, `REVOKED`, `CONSUMED`.

    • creditorsarray of objectsrequired

      Creditors attached to the request.

    • expirationDateTimestring· date-time

      When the request expires.

    • additionalInformationstring

      Additional payer-facing note.

    • debitorAccountNumberstring

      Debtor account number when known.

    • debitorAccountIssuerstring

      Debtor branch code.

    • debitorAccountTypestring

      `CACC`, `SVGS`, or `TRAN`.

    • debitorAccountIspbstring

      Debtor institution ISPB.

    • redirectUristring

      Callback URI configured for this request.

    • organisationIdstring

      Organisation id.

    • authorisationServerIdstring

      Authorisation server id.

    • rejectionReasonstring

      Populated when the holder rejects the flow.

    • automaticPaymentsarray of objectsrequired

      Automatic payments spawned under this request.

    • canBeAutomaticallyRevokedbooleanrequired

      Whether automatic revocation is allowed.

  • messagestring

    Response message.

  • typestring

    Envelope type.

200 · Payment request returned successfully.
{
  "data": {
    "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1",
    "createDateTime": "2026-05-01T12:00:00Z",
    "lastChangedDateTime": "2026-05-01T12:05:00Z",
    "subTenant": {
      "id": "st_1",
      "subTenantId": "subtenant_abc123",
      "name": "Demo"
    },
    "consentId": "urn:consent:abc123",
    "loggedUserIdentity": "76109277673",
    "loggedUserType": "CPF",
    "status": "EM_PROCESSAMENTO",
    "consentStatus": "AUTHORISED",
    "creditors": [],
    "automaticPayments": [],
    "canBeAutomaticallyRevoked": false
  },
  "message": "",
  "type": "success"
}

Next steps