Create a checkout
Creates a new checkout.
Body parameters
Required if the parameters amount
and currency
are not provided.
The items are the products that are being sold.
Required if the parameter items
is not provided.
The total amount of the checkout.
Required if the parameter amount
is provided.
A lowercase ISO currency code. Currently supported currencies are: “dzd”.
The payment method that will be used to pay the checkout. Currently supported payment methods are: “edahabia”, “cib” and “chargily_app”. The customer can always change the payment method at the checkout page.
When the payment method is “chargily_app”, a “qr_code_url” param will be returned in the response.
The URL where your customer will be redirected after a successful payment.
The ID of an existing Customer.
The URL where your customer will be redirected after a failed or canceled payment.
The URL of your endpoint that will receive the webhook events sent by Chargily Pay.
A description of the checkout. You can use this field to save a note about the checkout.
The language of the checkout page, accepted values are: ‘ar’, ‘en’ or ‘fr’.
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.
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).
The shipping address of the customer for the checkout.
A Boolean value indicates whether the shipping address should be collected from the customer.
Prohibited if the parameter amount_discount
is provided.
A percentage discount that will be applied to the total amount of the checkout.
Prohibited if the parameter percentage_discount
is provided.
An amount discount that will be applied to the total amount of the checkout.
A Set of key-value pairs that can be used to store additional information about the product.
Returns
If the request is successful, it returns a checkout object.