{
   "id": "01hj5n7cqpaf0mt2d0xx85tgz8",
   "entity": "checkout",
   "livemode": false,
   "amount": 2500,
   "currency": "dzd",
   "fees": 0,
   "fees_on_merchant": 0,
   "fees_on_customer": 0,
   "pass_fees_to_customer": null,
   "chargily_pay_fees_allocation": "customer",
   "status": "pending",
   "locale": "en",
   "description": null,
   "metadata": null,
   "success_url": "https://my-app.com/payments/success",
   "failure_url": "https://my-app.com/payments/failure",
   "webhook_endpoint": null,
   "payment_method": null,
   "invoice_id": null,
   "customer_id": "01hj150206g0jxnh5r2yvvdrna",
   "payment_link_id": null,
   "created_at": 1703144567,
   "updated_at": 1703144567,
   "shipping_address": null,
   "collect_shipping_address": 0,
   "discount": {
        "type": "percentage",
        "value": 50
    },
   "amount_without_discount": 5000,
   "checkout_url": "https://pay.chargily.dz/test/checkouts/01hj5n7cqpaf0mt2d0xx85tgz8/pay"
}

Attributes

id
string

The unique identifier of the checkout.

entity
string

A String represents the type of the object.

livemode
boolean

A “True” value means the request was made in Live Mode, while a “False” indicates Test Mode.

amount
integer

The total of all the items in the checkout.

currency
string

The currency of the checkout. A 3-letter ISO code.

fees
integer

The total fees of the checkout.

fees_on_merchant
integer

The fees of the checkout that will be paid by the merchant.

fees_on_customer
integer

The fees of the checkout that will be paid by the customer.

pass_fees_to_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.

chargily_pay_fees_allocation
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).

status
string

The current status of the checkout. Can be one of “pending”, “processing”, “paid”, “failed” or “canceled”,

locale
string

The language of the checkout page, accepted values are: ‘ar’, ‘en’ or ‘fr’.

description
string

A description of the checkout. You can use this field to save a note about the checkout.

success_url
string

The URL where your customer will be redirected after a successful payment.

failure_url
string

The URL where your customer will be redirected after a failed or canceled payment.

webhook_endpoint
string

The URL of your endpoint that will receive the webhook events sent by Chargily Pay.

payment_method
nullable, string

The payment method used to make the payment.

invoice_id
nullable, string

The unique identifier (ID) of the invoice that was paid.

customer_id
nullable, string

The ID of an existing Customer.

payment_link_id
nullable, string

The unique identifier (ID) of the payment link. In case the checkout was created using a payment link.

metadata
dictionary

A Set of key-value pairs that can be used to store additional information about the checkout.

created_at
timestamp

Timestamp indicating when the checkout was created.

updated_at
timestamp

Timestamp indicating when the last time the checkout was updated (edited).

shipping_address
string

The shipping address of the customer for the checkout.

collect_shipping_address
boolean

A Boolean value indicates whether the shipping address should be collected from the customer.

discount
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.

amount_without_discount
integer

The total amount of the checkout before applying the discount.

checkout_url
string

The URL where your customer will be redirected to make the payment.

{
   "id": "01hj5n7cqpaf0mt2d0xx85tgz8",
   "entity": "checkout",
   "livemode": false,
   "amount": 2500,
   "currency": "dzd",
   "fees": 0,
   "fees_on_merchant": 0,
   "fees_on_customer": 0,
   "pass_fees_to_customer": null,
   "chargily_pay_fees_allocation": "customer",
   "status": "pending",
   "locale": "en",
   "description": null,
   "metadata": null,
   "success_url": "https://my-app.com/payments/success",
   "failure_url": "https://my-app.com/payments/failure",
   "webhook_endpoint": null,
   "payment_method": null,
   "invoice_id": null,
   "customer_id": "01hj150206g0jxnh5r2yvvdrna",
   "payment_link_id": null,
   "created_at": 1703144567,
   "updated_at": 1703144567,
   "shipping_address": null,
   "collect_shipping_address": 0,
   "discount": {
        "type": "percentage",
        "value": 50
    },
   "amount_without_discount": 5000,
   "checkout_url": "https://pay.chargily.dz/test/checkouts/01hj5n7cqpaf0mt2d0xx85tgz8/pay"
}