Skip to main content
GET
Buscar payment por ID
GET /transactions/:transactionId/payments/:paymentId Faz parte do recurso Pagamentos — o objeto e os status estão lá.
Os dois IDs precisam combinar. O pagamento tem de pertencer à transação informada no caminho; caso contrário a resposta é 404, mesmo que ambos existam na sua conta.
Para boleto, use boletoUrl, boletoDigitableLine e boletoBarcode. Para PIX, use pixUrl (QR Code) e pixCopyPaste (copia-e-cola). Esses campos só ficam preenchidos depois que o pagamento é processado pelo gateway.
Este endpoint alcança tentativas que a transação esconde. GET /transactions/:id omite os pagamentos em replaced; aqui eles aparecem. É para isso que ele existe — siga o replacedByPaymentId do pagamento novo para chegar à tentativa anterior.
Em compensação, ele traz menos detalhe do cartão. Os pagamentos embutidos em GET /transactions/:id vêm com o objeto card (bandeira, últimos quatro dígitos) e com splits enriquecidos; aqui não. Se você precisa desses dados, busque pela transação.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

paymentId
string
required

ID do payment

transactionId
string
required

ID da transação

Response

Dados do payment

id
string

Identificador único do registro.

transactionId
string

ID da transação relacionada ao registro.

replacedByPaymentId
string | null

ID do pagamento que substituiu este, em caso de retentativa.

amount
integer

Valor em centavos.

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

installments
integer

Número de parcelas.

paymentMethod
string

Forma de pagamento (ex.: credit_card, pix, boleto).

cardId
string | null

ID do cartão tokenizado usado no pagamento.

status
string

Situação do pagamento. Valores: pending, waiting_payment, paid, refused, failed, canceled, replaced, waiting_refund, partially_refunded, refunded, chargeback, in_protest.

additionalInfo
object | null

Informações adicionais do registro (dados livres).

statementDescriptor
string | null

Texto exibido na fatura do cliente (statement descriptor).

billingAddress
object | null

Endereço de cobrança do cartão, como informado na criação da transação. Snapshot: preservado como veio, mesmo que o cadastro do cliente mude depois.

boletoUrl
string | null

URL para visualização e impressão do boleto.

boletoDigitableLine
string | null

Linha digitável do boleto.

boletoBarcode
string | null

Código de barras do boleto.

pixUrl
string | null

URL do QR Code PIX para pagamento.

pixCopyPaste
string | null

Código PIX copia e cola (payload EMV) para pagamento.

splitConfigId
string | null

ID da configuração de split aplicada ao pagamento.

originalAmount
integer | null

Valor original do pagamento antes de ajustes, em centavos.

acquirerReturnCode
string | null

Código de retorno enviado pelo adquirente ao processar o pagamento.

acquirerReturnMessage
string | null

Mensagem de retorno enviada pelo adquirente ao processar o pagamento.

retryable
boolean | null

Indica se o pagamento recusado pode ser retentado.

declineCode
string | null

Código de recusa retornado pelo adquirente.

errorMessage
string | null

Mensagem de erro quando o processamento falha.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).

paidAt
string<date-time> | null

Data e hora em que o pagamento foi liquidado (ISO 8601).

expiresAt
string<date-time> | null

Data e hora em que o registro expira (ISO 8601).

canceledAt
string<date-time> | null

Data e hora em que a transação foi cancelada (ISO 8601).

refundedAt
string<date-time> | null

Data e hora em que o estorno foi concluído (ISO 8601).

chargedbackAt
string<date-time> | null

Data e hora em que a transação sofreu chargeback (ISO 8601).

protestedAt
string<date-time> | null

Data e hora em que a transação foi protestada (ISO 8601).