Pular para o conteúdo

Get automatic payment request

Returns one automatic payment request by id, including consent state, creditors, and related metadata (values may be masked per policy). Call this after the payer returns from redirectUrl on Create automatic payment request.

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

Get automatic payment request

Returns detailed information about one automatic payment request.

Auth: Bearer Token

Parâmetros de path

1 campo
automaticPaymentsRequestId●
pathstring

Automatic payment request id (same as paymentRequestId from create response).

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

Response

200Request found.
Response body
object
  • dataobjectrequired

    Automatic payment request record.

    • idstringrequired

      Request id.

    • createDateTimestringrequired· date-time
    • lastChangedDateTimestringrequired· date-time
    • consentIdstring

      Consent id when issued.

    • loggedUserIdentitystring

      Masked or partial payer document.

    • loggedUserTypestring

      Document type (e.g. CPF).

    • statusstringrequired

      Request status: PENDENTE | EM_PROCESSAMENTO | CONSUMIDO | EXPIRADO | CANCELADO | ERRO_NA_DETENTORA | ERRO.

    • consentStatusstring

      Consent status such as AWAITING_AUTHORISATION, AUTHORISED, REJECTED, REVOKED.

  • messagestring
  • typestring
200 · Request found.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createDateTime": "2024-01-15T10:30:00Z",
    "lastChangedDateTime": "2024-01-15T10:35:00Z",
    "consentId": "consent-123",
    "loggedUserIdentity": "***9277673",
    "loggedUserType": "CPF",
    "status": "EM_PROCESSAMENTO",
    "consentStatus": "AWAITING_AUTHORISATION"
  },
  "message": "",
  "type": "success"
}

Next steps