API Reference

Attributes

id string(36)
Unique identifier for the object.


code string(36)
Unique identifier for the object in your system.


amount integer(>0)
Amount in cents to be paid.


paidAmount integer(>0)
Amount in cents that was paid.


source
...


destination
...


payer Payer
This object represents a payer of the payment.


split Split
**


status enum
The status of the payment. Can be CREATED, PROCESSED, PAID, REFUNDED, ERROR or FAILED.

StatusDescription
CREATEDIndicates that the payment was received.
PROCESSEDIndicates that the payment was processed by provider but needs confirmation.
PAIDIndicates that the payment was confirmed.
REFUNDEDIndicates that the payment was refunded.
ERRORIndicates that one or more errors occurred during payment processing but is not a final state.
FAILEDIndicates that the payment was not processed.

createdAt datetime
Time at which the object was created.


processedAt datetime
Time at which the object was processed.


paidAt datetime
Time at which the object was paid.


failedAt datetime
Time at which the object failed.


metadata Metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.