Get payment request

Returns the full state of a payment request by its paymentRequestId — the same id returned by Create payment consent and echoed in Authorise payment. Use this to confirm the latest status when the synchronous authorise-payment response doesn't come back with a final status yet — see How payment status settles.

Look for status: CONSUMIDO at the request level and status: PAGO on each entry of payments[] to confirm the happy path. PENDENTE / EM_PROCESSAMENTO mean the payment hasn't reached a final status yet.

GET/api/v1/payments/requests/{paymentRequestId}

Get payment request details by ID

Admin and Tenant users may optionally pass the subTenantId header to get a payment request on behalf of a sub-tenant. Tenant users must own the informed sub-tenant.

Auth: Bearer Token

Path parameters

1 campo

paymentRequestId●

pathstring

ID of the payment request.

Headers

1 campo

subTenantId

headerstring

Target sub-tenant ID. When provided by Admin or Tenant, the request is queried for that sub-tenant. Tenant users must own the sub-tenant.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/payments/requests/payment123' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123'

Response

200The payment request has been successfully retrieved.

Response body

object

dataobjectrequired
RetornoPaymentRequestDto — same shape returned by Authorise payment.
- idstringrequired
  ID of the payment request.
- createDateTimestringrequired· date-time
- lastChangedDateTimestringrequired· date-time
- externalCommentstring· nullable
- externalIdstring· nullable
- cpfCnpjstring· nullable
- redirectUristring· nullable
- tenantIdstringrequired
- consentIdstring· nullable
- valuenumberrequired
- statusstringrequired
  PENDENTE | EM_PROCESSAMENTO | CONSUMIDO | EXPIRADO | CANCELADO | ERRO_NA_DETENTORA | ERRO
- creditorobjectrequired
- debitorobject· nullable
- typestring· nullable
  NOW | SINGLE | DAILY | WEEKLY | MONTHLY | CUSTOM
- paymentsarray of objectsrequired
- requestExpiresAtstring· nullable
- businessCnpjstring· nullable
- localInstrumentstring· nullable
  MANU | DICT | QRDN | QRES | INIC | APES | APDN
messagestring
Response message.
typestring
Envelope type.
statusCodeinteger· nullable
HTTP status in envelope.

200 · The payment request has been successfully retrieved.

{
  "data": {
    "id": "payment123",
    "createDateTime": "2024-06-01T12:00:00Z",
    "lastChangedDateTime": "2024-06-02T12:00:00Z",
    "externalComment": "Payment processed",
    "externalId": "ext123",
    "cpfCnpj": "12345678901234",
    "redirectUri": "http://example.com/redirect",
    "tenantId": "tenant123",
    "consentId": "consent123",
    "value": 1500.5,
    "status": "CONSUMIDO",
    "creditor": {
      "name": "John Doe",
      "personType": "PESSOA_NATURAL",
      "cpfCnpj": "12345678901234",
      "accountNumber": "1234567890",
      "accountIssuer": "0001",
      "accountPixKey": "email@example.com",
      "accountIspb": "12345678",
      "accountType": "CACC"
    },
    "debitor": {
      "accountNumber": "1234567890",
      "accountIssuer": "0001",
      "accountIspb": "12345678",
      "accountType": "CACC"
    },
    "type": "SINGLE",
    "payments": [
      {
        "id": "payment123",
        "endToEndId": "E47133056202409201011eCPvUq3GjmK",
        "dueDate": "2024-06-01T12:00:00Z",
        "externalComment": "Payment processed",
        "txId": "ext123",
        "externalPaymentId": "consent123",
        "status": "PAGO",
        "rejectionReason": null,
        "rejectionReasonDetail": null
      }
    ],
    "requestExpiresAt": "2024-09-01T12:00:00Z",
    "businessCnpj": "12345678000195",
    "localInstrument": "MANU"
  },
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps

Get payment from holder — force a live status check directly at the account holder instead of Lina's stored record.