Attributes
string
The unique identifier of the checkout.
string
A String represents the type of the object.
boolean
A “True” value means the request was made in Live Mode, while a “False”
indicates Test Mode.
integer
The total of all the items in the checkout.
string
The currency of the checkout. A 3-letter ISO code.
integer
The total fees of the checkout.
integer
The fees of the checkout that will be paid by the merchant.
integer
The fees of the checkout that will be paid by the customer.
boolean
DEPRECATED, use chargily_pay_fees_allocation instead.A Boolean value indicates whether the Chargily Pay fees will be paid by you,
the merchant, or your customers.
string
Can be one of “customer”, “merchant” or “split”.Choose who is going to pay Chargily Pay fees (“Merchant” means you will pay the fees, “Customer” means the customer will pay the fees, “Split” means you will split the fees with the customer).
string
The current status of the checkout. Can be one of “pending”, “processing”,
“paid”, “failed” or “canceled”,
string
The language of the checkout page, accepted values are: ‘ar’, ‘en’ or ‘fr’.
string
A description of the checkout. You can use this field to save a note about the
checkout.
string
The URL where your customer will be redirected after a successful payment.
string
The URL where your customer will be redirected after a failed or canceled
payment.
string
The URL of your endpoint that will receive the webhook events sent by Chargily
Pay.
nullable, string
The payment method used to make the payment.
nullable, string
The unique identifier (ID) of the invoice that was paid.
nullable, string
The unique identifier (ID) of the payment link. In case the checkout was
created using a payment link.
dictionary
A Set of key-value pairs that can be used to store additional information
about the checkout.
timestamp
Timestamp indicating when the checkout was created.
timestamp
Timestamp indicating when the last time the checkout was updated (edited).
string
The shipping address of the customer for the checkout.
boolean
A Boolean value indicates whether the shipping address should be collected
from the customer.
string
The discount applied to the checkout. It’s an object that contains the
discount type (“percentage” or “amount”) and the value of the discount.
integer
The total amount of the checkout before applying the discount.
string
The URL where your customer will be redirected to make the payment.