API Reference

Community

Chargily Pay Documentation

Dashboard

Live Support

Fees

Welcome to the documentation of Chargily Pay

Introduction

Learn how to create a Chargily Pay account.

Create an account

Learn more about the concept of one account, multiple applications.

Applications

Test and Live modes

Learn where to get your application's API keys.

API keys

Learn more about the verification process and activating Live Mode to start accepting payments..

Account verification

Learn how to use webhooks to make your application react to events from Chargily Pay.

Webhooks

Let's send your first Chargily Pay API request.

Things you need to do before getting started.

Before you start

Create a Checkout by providing an amount and get the payment link.

Create a checkout

It's time to send your first API request!

1. Your first API request - create a new Product

Let's now create a Price for the Product you previously created.

2. Create a price

You can now create a Checkout using the Price you just created.

3. Create a checkout

Learn how to handle Chargily Pay's webhooks in your application.

Handle webhooks

Authentication

This object represents your Chargily Pay balance. You can retrieve it to see the balance of your 03 wallets (DZD, USD and EUR).

The Balance object

Retrieves the current account (based the API Secret Key employed in the request) balance for the three wallets (DZD, EUR, and USD).

Retrieve balance

This represents a customer of your business.

The Customer object

Create a customer

Updates the information of a customer by defining the values for the passed parameters. Any parameters not supplied will remain unaltered.

Update a customer

Retrieves all the information of an already-existing customer by providing it's unique identifier (ID).

Retrieve a customer

List all customers

Delete a customer

Products represent the goods or services you are selling to your customers.

The Product object

Create a product

Updates the information of a product by defining the values for the passed parameters. Any parameters not supplied will remain unaltered.

Update a Product

Retrieves all the information of an already-existing product by providing it's unique identifier (ID).

Retrieve a product

List all products

Delete a product. Product deletion is feasible only when there are no associated prices linked to it.

Delete a product

Retrieve a products's prices

Prices define the unit cost and the currency of products. A product can have multiple prices.

The Price object

Create a price

Updates the information of a price by defining the values for the passed parameters. Any parameters not supplied will remain unaltered.

Update a price

Retrieves all the information of an already-existing price by providing it's unique identifier (ID).

Retrieve a price

List all prices

A Checkout is used to make your customers make a payment. Each time your customer wants to pay, you have to create a new Checkout.

The Checkout object

Retrieves all the information of an already-existing checkout by providing it's unique identifier (ID).

Retrieve a checkout

List all checkouts

Retrieve a checkout's items

Expire a checkout

A Payment Link is a URL that can be shared and when accessed, directs your customers to a hosted payment page. This link can be utilized multiple times. Every time a customer accesses the link, a new [Checkout](/v2/api-reference/checkouts/checkout-object 'Checkout') is generated.

The Payment Link object

Create a payment link

Updates the information of a payment link by defining the values for the passed parameters. Any parameters not supplied will remain unaltered.

Update a Payment Link

Retrieves all the information of an already-existing payment link by providing it's unique identifier (ID).

Get Started

Must Know

Start The Integration

Fees