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: 
{
  "id": "pay_xyz789abc",
  "livemode": false,
  "customer": {
    "id": "cus_ahwDXrgYvur89iPs",
    "name": "John Doe",
    "email": "[email protected]"
  },
  "paymentMethod": {
    "id": "pm_abc123xyz",
    "type": "credit_card",
    "lastDigits": "1111",
    "brand": "visa"
  },
  "amount": 10000,
  "gross": 10000,
  "mdr": 0,
  "net": 10000,
  "interest": 0,
  "currency": "BRL",
  "status": "paid",
  "pixQrCode": null,
  "refuseReason": null,
  "installments": 1,
  "createdAt": 1731622178441,
  "updatedAt": 1731622178441,
  "dueAt": null
}

​
Atributos:

{
  "id": "pay_xyz789abc",
}
id : string.
Identificador único do pagamento, começando com pay_
{
  "livemode": false,
}
livemode : boolean.
Indica se o pagamento está em modo de produção (true) ou teste (false)
{
  "customer": {
    "id": "cus_ahwDXrgYvur89iPs",
    "name": "John Doe",
    "email": "[email protected]"
  }
}
customer : object
Objeto contendo informações do cliente. Veja a referência completa aqui
{
  "paymentMethod": {
    "id": "pm_abc123xyz",
    "type": "credit_card",
    "lastDigits": "1111",
    "brand": "visa"
  }
}
paymentMethod : object
Objeto contendo informações do método de pagamento. Veja a referência completa aqui
{
  "amount": 10000,
}
amount : number.
Valor do pagamento em centavos
{
  "gross": 10000,
}
gross : number.
Valor bruto do pagamento em centavos (antes das taxas)
{
  "mdr": 0,
}
mdr : number.
Taxa MDR (Merchant Discount Rate) em centavos
{
  "net": 10000,
}
net : number.
Valor líquido do pagamento em centavos (após taxas)
{
  "interest": 0,
}
interest : number.
Valor de juros em centavos (para parcelamentos)
{
  "currency": "BRL",
}
currency : string.
Código da moeda (ex.: BRL)
{
  "status": "paid",
}
status : string.
Status atual do pagamento
StatusDescrição
pendingO pagamento está pendente
paidO pagamento foi realizado com sucesso
failedO pagamento falhou
refundedO valor foi devolvido ao cliente
{
  "pixQrCode": null,
}
pixQrCode : string | null.
Código QR do PIX para pagamento. Pode ser null se não for PIX
{
  "refuseReason": null,
}
refuseReason : string | null.
Motivo da recusa do pagamento. Pode ser null se não foi recusado
{
  "installments": 1,
}
installments : number.
Número de parcelas. Padrão: 1
{
  "createdAt": 1731622178441,
}
createdAt : number.
Timestamp Unix indicando quando o pagamento foi criado
{
  "updatedAt": 1731622178441,
}
updatedAt : number.
Timestamp Unix indicando quando o pagamento foi atualizado pela última vez
{
  "dueAt": null,
}
dueAt : number | null.
Timestamp Unix indicando a data de vencimento do pagamento. Pode ser null