Get payment from holder

Consults the payment directly at the account holder by internal payment ID and updates the local record if the status has changed. Use this for client-side polling: unlike Get payment request, which returns Lina's stored record, this endpoint forces a live check against the ASPSP — see How payment status settles for when to reach for this instead of the webhook or Lina's internal 2-hour polling.

GET/api/v1/payments/{paymentId}/external

Get payment from holder

Consults the payment at the holder by payment ID and updates the local record if the status has changed. For non-admin users, validates that the payment belongs to the token sub-tenant.

Auth: Bearer Token

Path parameters

1 campo

paymentId●

pathstring

ID of the payment (internal UUID).

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

Response

200Payment details retrieved from holder successfully.

Response body

object

dataobjectrequired
RetornoOnePaymentDto.
- idstringrequired
  ID of the payment.
- createDateTimestringrequired· date-time
- lastChangedDateTimestringrequired· date-time
- externalCommentstring· nullable
- txIdstring· nullable
- cpfCnpjstring· nullable
- redirectUristring· nullable
- tenantIdstringrequired
- consentIdstring· nullable
- valuenumberrequired
- creditorobjectrequired
- debitorobject· nullable
- dueDatestringrequired· date-time
- externalPaymentIdstring· nullable
- statusstringrequired
  PENDENTE | REJEITADO | EM_PROCESSAMENTO | PAGO | EXPIRADO | CANCELADO | ERRO_NA_DETENTORA | ERRO | PROGRAMADO | AGUARDANDO_VALOR | PRONTO_PARA_ENVIO | EXCLUIDO
- paymentNumbernumber· nullable
  Actual payment number.
- totalPaymentsnumber· nullable
  Total of payments in the consent.
- paymentTypestring· nullable
  NOW | SINGLE | DAILY | WEEKLY | MONTHLY | CUSTOM
- rejectionReasonstring· nullable
- rejectionReasonDetailstring· nullable
messagestring
Response message.
typestring
Envelope type.
statusCodeinteger· nullable
HTTP status in envelope.

200 · Payment details retrieved from holder successfully.

{
  "data": {
    "id": "payment123",
    "createDateTime": "2024-06-01T12:00:00Z",
    "lastChangedDateTime": "2024-06-02T12:00:00Z",
    "externalComment": "Payment processed",
    "txId": "ext123",
    "cpfCnpj": "12345678901234",
    "redirectUri": "http://example.com/redirect",
    "tenantId": "tenant123",
    "consentId": "consent123",
    "value": 1500.5,
    "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"
    },
    "dueDate": "2024-06-01T12:00:00Z",
    "externalPaymentId": "consent123",
    "status": "PAGO",
    "paymentNumber": 1,
    "totalPayments": 10,
    "paymentType": "MONTHLY",
    "rejectionReason": null,
    "rejectionReasonDetail": null
  },
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps

Get payment request — the lighter-weight, non-live-checking alternative when you just need Lina's stored status.