Skip to main content
GET
Buscar payment por ID
GET /payments/:paymentId Faz parte do recurso Pagamentos — o objeto e os status estão lá.
Basta o ID do pagamento. A transação a que ele pertence vem em transactionId — é por ele que você chega aos itens e aos outros pagamentos, em GET /transactions/:id.
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.
O pagamento vem igual ao embutido na transação. card traz o cartão usado (bandeira, primeiros e últimos dígitos, titular, validade) e não vem quando o pagamento não tem cartão associado — Pix e boleto, por exemplo. splits traz a divisão do valor, com o recipientName de cada recebedor, e vem [] quando não há split.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

paymentId
string
required

ID do payment

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.

retryable
boolean | null

Se vale tentar de novo com o mesmo cartão. true: uma nova tentativa pode ser aprovada. false: repetir não adianta, peça outro cartão. null: sem veredito.

declineCode
string | null

Motivo da recusa, num código da Z2Pay que é o mesmo para qualquer processador (ex.: insufficient_funds, invalid_cvv, fraud_suspected). null quando o pagamento não foi recusado. Trate um valor desconhecido como unknown.

errorMessage
string | null

Texto pronto para exibir ao comprador, em pt-BR. Nos motivos sensíveis (fraude, cartão roubado) é genérico de propósito. Pode mudar sem aviso: decida pelo declineCode, nunca por este texto.

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).

card
object | null

Dados do cartão usado no pagamento. Ausente fora de credit_card.

splits
object[]

Divisão do valor deste pagamento entre recebedores. Vazio quando não há split.