Skip to main content
GET
https://pay.chargily.net/test/api/v2
/
checkouts
/
{id}
Retrieve a 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,
  "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"
}

​
Path parameters

​
id
string
The ID of the checkout.

​
Returns

If a valid ID is provided, it returns a checkout object. 
{
  "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"
}