Payment overview

A payment is a promise from a bill, it can be a pix, boleto or card.

Payment schema

FieldDescriptionType
idUnique identifier (UUID)String
statusPayment status, unpaid, failed, refused, paid, refunded, waiting_refund, chargebackString
payment_methodPayment method, boleto, credit_card, pixString
amount_centsAmount in cents of that paymentInteger
paid_amount_centsTotal paid amount in cents of that paymentInteger
refunded_amount_centsTotal refunded amount in cents of that paymentInteger
paid_atTimestamp indicating when the payment was paidString
refunded_atTimestamp indicating when the payment was refundedString
installmentsIndicates in how much installments the payment was split. If boleto or pix this will always be 1Integer
urlHere you have access to the boleto urlString
barcodeHere you have access to the boleto barcode or pix QR codeString
expires_atTimestamp indicating when the payment will expireString
created_atIndicates when the record was created in iso8601String
updated_atIndicates when the record was last updated in iso8601String