Checkouts
Retrieve a checkout
- Documentation
- API Reference
- Community
- The Customer object
- POSTCreate a customer
- POSTUpdate a customer
- GETRetrieve a customer
- GETList all customers
- DELDelete a customer
- The Product object
- POSTCreate a product
- POSTUpdate a Product
- GETRetrieve a product
- GETList all products
- DELDelete a product
- GETRetrieve a products's prices
Customers
Products
Checkouts
Retrieve a checkout
Retrieves all the information of an already-existing checkout by providing it’s unique identifier (ID).
GET
/
checkouts
/
{id}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
id
string
id
string
The ID of the checkout.
curl --request GET \
--url https://pay.chargily.net/test/api/v2/checkouts/{id} \
--header 'Authorization: Bearer <token>'{
"id": "01hj5n7cqpaf0mt2d0xx85tgz8",
"entity": "checkout",
"livemode": false,
"amount": 2500,
"currency": "dzd",
"fees": 0,
"pass_fees_to_customer": 0,
"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"
}
Path parameters
id
string
The ID of the checkout.
Returns
If a valid ID is provided, it returns a checkout object.
curl --request GET \
--url https://pay.chargily.net/test/api/v2/checkouts/{id} \
--header 'Authorization: Bearer <token>'{
"id": "01hj5n7cqpaf0mt2d0xx85tgz8",
"entity": "checkout",
"livemode": false,
"amount": 2500,
"currency": "dzd",
"fees": 0,
"pass_fees_to_customer": 0,
"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"
}