Skip to main content
GET
https://pay.chargily.net/test/api/v2
/
checkouts
List all checkouts
curl --request GET \
  --url https://pay.chargily.net/test/api/v2/checkouts \
  --header 'Authorization: Bearer <token>'
{
  "livemode": false,
  "current_page": 1,
  "data": [
    {
      "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"
    },
    {
      "id": "01hj152n3w1xh3vqzyhx97gfbh",
      "entity": "checkout",
      "livemode": false,
      "amount": 5000,
      "currency": "dzd",
      "fees": 0,
      "fees_on_merchant": 0,
      "fees_on_customer": 0,
      "pass_fees_to_customer": null,
      "chargily_pay_fees_allocation": "customer",
      "status": "canceled",
      "locale": "ar",
      "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": "01hhhtvg4w7gk4mcaxmgzb2ynw",
      "payment_link_id": null,
      "created_at": 1703144567,
      "updated_at": 1703144567,
      "shipping_address": null,
      "collect_shipping_address": 0,
      "discount": null,
      "amount_without_discount": null,
      "checkout_url": "https://pay.chargily.dz/test/checkouts/01hj152n3w1xh3vqzyhx97gfbh/pay"
    }
  ],
  "first_page_url": "https://pay.chargily.net/test/api/v2/customers?page=1",
  "last_page": 1,
  "last_page_url": "https://pay.chargily.net/test/api/v2/customers?page=1",
  "next_page_url": null,
  "path": "https://pay.chargily.net/test/api/v2/customers",
  "per_page": 10,
  "prev_page_url": null,
  "total": 2
}

​
Query parameters

​
per_page
integer
A numeric value indicating the quantity of checkouts to be returned with the request, with a minimum value of 1 and a maximum value of 50.

​
Returns

A key-value array, containing a data property which is an array of checkouts, limited to a maximum of per_page value. 
{
  "livemode": false,
  "current_page": 1,
  "data": [
    {
      "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"
    },
    {
      "id": "01hj152n3w1xh3vqzyhx97gfbh",
      "entity": "checkout",
      "livemode": false,
      "amount": 5000,
      "currency": "dzd",
      "fees": 0,
      "fees_on_merchant": 0,
      "fees_on_customer": 0,
      "pass_fees_to_customer": null,
      "chargily_pay_fees_allocation": "customer",
      "status": "canceled",
      "locale": "ar",
      "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": "01hhhtvg4w7gk4mcaxmgzb2ynw",
      "payment_link_id": null,
      "created_at": 1703144567,
      "updated_at": 1703144567,
      "shipping_address": null,
      "collect_shipping_address": 0,
      "discount": null,
      "amount_without_discount": null,
      "checkout_url": "https://pay.chargily.dz/test/checkouts/01hj152n3w1xh3vqzyhx97gfbh/pay"
    }
  ],
  "first_page_url": "https://pay.chargily.net/test/api/v2/customers?page=1",
  "last_page": 1,
  "last_page_url": "https://pay.chargily.net/test/api/v2/customers?page=1",
  "next_page_url": null,
  "path": "https://pay.chargily.net/test/api/v2/customers",
  "per_page": 10,
  "prev_page_url": null,
  "total": 2
}