Pular para o conteúdo

Get payment by TxID

Fetches a single payment by its transaction identification (txId). Unlike Get payment request and Get payment by external ID, which return the full payment request wrapper, this endpoint returns only the payment entry — use it when you already know which specific payment you want to inspect (for example, one schedule out of a recurrence).

GET/api/v1/payments/txid/{txId}

Get payment by TxID

Returns a single payment identified by its transaction identification.

Auth: Bearer Token

Parâmetros de path

1 campo
txId●
pathstring

Transaction identification of the payment (one of the values sent in `payment.txId[]` at consent creation, or returned inside `payments[].txId`).

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

Response

200Payment retrieved successfully.
Response body
object
  • dataobjectrequired

    Payment details.

    • idstringrequired

      ID of the payment.

    • dueDatestringrequired· date-time

      Due date of the payment.

    • externalCommentstringrequired· nullable

      External comment associated with the payment.

    • txIdstringrequired· nullable

      Transaction identification of the payment.

    • externalPaymentIdstringrequired· nullable

      External payment ID associated with the payment.

    • statusstringrequired

      Payment status. One of `PENDENTE`, `REJEITADO`, `EM_PROCESSAMENTO`, `PAGO`, `EXPIRADO`, `CANCELADO`, `ERRO_NA_DETENTORA`, `ERRO`.

  • messagestring

    Response message.

  • typestring

    Response type. One of `error`, `warning`, `info`, `success`.

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Payment retrieved successfully.
{
  "data": {
    "id": "pay_abc",
    "dueDate": "2024-06-01T12:00:00Z",
    "externalComment": "Payment processed",
    "txId": "tx_xyz",
    "externalPaymentId": "ext123",
    "status": "PAGO"
  },
  "message": "OK",
  "type": "success",
  "statusCode": 200
}

Next steps