Pular para o conteúdo

Get payment by ID

Returns a single payment with full context (RetornoOnePaymentDto): request-level fields (tenant, consent, redirect, creditor, value) plus installment metadata such as dueDate, paymentNumber, and totalPayments. Use this on settlement day when you need more than the slim row returned inside payments[] on Get payment request.

GET/api/v1/payments/{paymentId}

Get payment details by ID

Returns one payment identified by its payment id, including creditor, debitor, and schedule metadata.

Auth: Bearer Token

Parâmetros de path

1 campo
paymentId●
pathstring

ID of the payment (from `payments[].id` on the payment request).

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

Response

200Payment retrieved successfully.
Response body
object
  • dataobjectrequired

    Single payment with full details.

    • idstringrequired

      ID of the payment.

    • createDateTimestringrequired· date-time

      Creation date and time.

    • lastChangedDateTimestringrequired· date-time

      Last modification date and time.

    • externalCommentstringrequired· nullable

      External comment.

    • txIdstringrequired· nullable

      Transaction identification.

    • cpfCnpjstringrequired· nullable

      Payer CPF or CNPJ.

    • redirectUristringrequired· nullable

      Redirect URI used for the flow.

    • tenantIdstringrequired

      Tenant ID.

    • consentIdstringrequired· nullable

      Consent ID.

    • valuenumberrequired

      Payment value in BRL.

    • creditorobjectrequired

      Creditor details.

    • debitorobjectrequired· nullable

      Debtor account details or null.

    • dueDatestringrequired· date-time

      Due date of this installment.

    • externalPaymentIdstringrequired· nullable

      External payment ID.

    • statusstringrequired

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

    • paymentNumbernumberrequired· nullable

      1-based index of this installment within the consent.

    • totalPaymentsnumberrequired· nullable

      Total number of payments in the consent.

  • messagestring

    Response message.

  • typestring

    Response type.

  • statusCodeinteger· nullable

    HTTP status inside envelope.

200 · Payment retrieved successfully.
{
  "data": {
    "id": "pay_abc",
    "createDateTime": "2024-06-01T12:00:00Z",
    "lastChangedDateTime": "2024-06-02T12:00:00Z",
    "externalComment": null,
    "txId": "tx_xyz",
    "cpfCnpj": "12345678901234",
    "redirectUri": "https://your-app.example.com/payments/callback",
    "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": null,
    "dueDate": "2024-07-01T12:00:00Z",
    "externalPaymentId": "ext123",
    "status": "PENDENTE",
    "paymentNumber": 1,
    "totalPayments": 12
  },
  "message": "OK",
  "type": "success",
  "statusCode": 200
}

Next steps