Structure
A PIX charge is represented by the following structure:Attributes
string
Unique identifier of the charge in CUID format.
string
Identifier of the charge in your system. Use it to reconcile data without storing the internal
id. Must be unique per project.integer
Charge amount in cents. Example:
10000 = R$ 100.00.string
Name or description of the product/service being charged. Appears in the PIX notification shown to the payer.
string
Current status of the charge.
string
PIX copy-and-paste code (Pix Payload Format Object). Available only when
status is waiting_payment.date-time
Date and time when the charge expires. After this moment, the status changes to
expired.string | null
Buyer’s email. A direct shortcut to the
customer.email field, available at the root level of the transaction.string | null
Buyer’s name. A direct shortcut to the
customer.name field, available at the root level of the transaction.object
Data of the buyer linked to the charge. See the Customer entity.
date-time
Date and time when the charge was created.
date-time
Date and time of the last update.
Next steps
Create charge
Generate a PIX with an amount, product, and buyer data.
Check status
Check the current state of a charge.