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.
selectedPaymentMethod enum
The selected payment method. Can be CREDIT_CARD
, PIX_QRCODE
, ITP
or BOLETO
availablePaymentMethods array of enum
The list of avalable payment methods. Can be CREDIT_CARD
, PIX_QRCODE
, ITP
and BOLETO
redirectUrl string(128)
The redirect URL
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.
deletedAt datetime
Time at which the object was deleted.
sqalaId
The ID of the payment
accountId
The ID of the account
status enum
The status of the payment. Can beCREATED
, PROCESSED
, PAID
or FAILED
.
Status | Description | Final Status |
---|---|---|
CREATED | Indicates that the payment was received. | No |
PENDING | Indicates that the payment was processed but needs confirmation. | No |
PAID | Indicates that the payment was confirmed. | Yes |
DELETED | Indicates that the payment was deleted | Yes |
creditCardSettings
This object represents the credit card settings of the payment.
Example
{
"id":"6a0b14a9-023c-4198-9ada-6e4684213340",
"code":"40040b70-89be-40ad-ab7f-7a123cb7ab6a",
"amount":990,
"paidAmount":null,
"availablePaymentMethods":[
"PIX_QRCODE",
"ITP",
"CREDIT_CARD"
],
"creditCardSettings":{
"executeThreeDSecure":true,
"installments":[
{
"number":1,
"amount":990
},
{
"number":2,
"amount":990
},
{
"number":3,
"amount":990
},
{
"number":12,
"amount":1100
}
]
},
"status":"CREATED",
"createdAt":"2022-06-06T11:48:21Z",
"processedAt":"2022-06-06T11:48:26Z",
"paidAt":null,
"deletedAt":null
}