Payment overview
A payment is a promise from a bill, it can be a pix, boleto or card.
Payment schema
Field | Description | Type |
---|---|---|
id | Unique identifier (UUID) | String |
status | Payment status, unpaid , failed , refused , paid , refunded , waiting_refund , chargeback | String |
payment_method | Payment method, boleto , credit_card , pix | String |
amount_cents | Amount in cents of that payment | Integer |
paid_amount_cents | Total paid amount in cents of that payment | Integer |
refunded_amount_cents | Total refunded amount in cents of that payment | Integer |
paid_at | Timestamp indicating when the payment was paid | String |
refunded_at | Timestamp indicating when the payment was refunded | String |
installments | Indicates in how much installments the payment was split. If boleto or pix this will always be 1 | Integer |
url | Here you have access to the boleto url | String |
barcode | Here you have access to the boleto barcode or pix QR code | String |
expires_at | Timestamp indicating when the payment will expire | String |
created_at | Indicates when the record was created in iso8601 | String |
updated_at | Indicates when the record was last updated in iso8601 | String |