Skip to main content
Um pagamento representa uma transação financeira onde seu cliente paga por produtos ou serviços usando um método de pagamento cadastrado.

Estrutura

Um pagamento é representado em nossa API pela seguinte estrutura:

Atributos:

id : string.
Identificador único do pagamento, começando com pay_
livemode : boolean.
Indica se o pagamento está em modo de produção (true) ou teste (false)
customer : object
Objeto contendo informações do cliente. Veja a referência completa aqui
paymentMethod : object
Objeto contendo informações do método de pagamento. Veja a referência completa aqui
amount : number.
Valor do pagamento em centavos
gross : number.
Valor bruto do pagamento em centavos (antes das taxas)
mdr : number.
Taxa MDR (Merchant Discount Rate) em centavos
net : number.
Valor líquido do pagamento em centavos (após taxas)
interest : number.
Valor de juros em centavos (para parcelamentos)
currency : string.
Código da moeda (ex.: BRL)
status : string.
Status atual do pagamento
pixQrCode : string | null.
Código QR do PIX para pagamento. Pode ser null se não for PIX
refuseReason : string | null.
Motivo da recusa do pagamento. Pode ser null se não foi recusado
installments : number.
Número de parcelas. Padrão: 1
createdAt : number.
Timestamp Unix indicando quando o pagamento foi criado
updatedAt : number.
Timestamp Unix indicando quando o pagamento foi atualizado pela última vez
dueAt : number | null.
Timestamp Unix indicando a data de vencimento do pagamento. Pode ser null