CHIP API

CHIP Collect

CHIP Send

Dashboard

Support

Blog

List all billing template clients for this billing template.


List all clients

Connects a Client object to a BillingTemplate having `is_subscription = true` to store information about a single subscriber.

 You will be able to pause an individual subscription client's cycle by PATCH-ing its' `status` field to the value of `subscription_paused`.

ID of the Client object to add to the BillingTemplate. Read-only after the BillingTemplateClient has been created. Note that the same Client can be added to a BillingTemplate several times.

An optional whitelist of payment methods availble for purchases generated for this BillingTemplateClient. Copied 1:1 to `Purchase.payment_method_whitelist` field on created Purchases (see its description).

Payment method name as returned by `GET /payment_methods/`.

Sends invoice when `POST /billing_templates/{id}/add_subscriber/` is called if this is `true`

Sends invoice when subscription charge fails if this is `true`

Sends receipt when subscription charge succeeds if this is `true`

For subscriptions, you can edit (`PATCH /billing_templates/{id}/clients/{id}/`) this status between `active` and `subscription_paused` values to pause the client's subscription. Paused subscriptions run as normal, except for purchases not being created and invoices sent for them. It means that if you pause a BillingTemplateClient's monthly subscription cycle a day before the billing date, the next day the invoice will not be issued; but, if you unpause the client a day after the planned billing would have taken place, the planned billing in a month (minus one day) will happen as usual.

Read-only if the BillingTemplateClient is in `inactive` (internal status not managed through public API) or `pending` (see documentation for `POST /billing_templates/{id}/add_subscriber/`) statuses.

If not null, reports the date when the next billing is scheduled for this client.

bearerAuth

Welcome to the CHIP Collect documentation

CHIP Collect API

Online purchases

Billing

Callbacks

Authentication

Create a purchase

Retrieve a purchase

Cancel a pending purchase

Release funds on hold

Capture a previously authorized payment

Charge a purchase using a saved token

Delete a recurring token associated with a purchase

Refund a paid purchase

Mark a purchase as paid

Resend an invoice

List of payment methods

Create a billing template

Retrieve a billing template

Update a billing template

Delete a billing template

List all billing templates

Send an invoice, generating a purchase from billing template data.

Send invoice

Add a billing template client and activate recurring billing (is_subscription: true).

Add subscriber

Retrieve a billing template client by client's ID.


Retrieve a client

Partially update a billing template client by client's ID.


Update a client

Create a client

Partially update a client

Delete a client

List recurring tokens

Retrieve a recurring token

Delete a recurring token

Create a webhook

Retrieve a webhook

Update a webhook

Delete a webhook

List all webhooks

Returns public key for authenticating company callback payloads

Retrieve a public key

Returns the company balance according to the provided query string filters. Multiple values can be provided for all filters except `from` and `to`, including all results matching any of these values.

Get company balance

Fetches the company turnover according to the provided query string filters. Must provide exactly one `currency` filter. Multiple values can be provided for all filters except `currency`, `from` and `to`, including all results matching any of these values.

Get company turnover

Schedule a statement

Retrieve a statement

Cancel a statement

List all statements

Introduction

List all accounts

Use this API to increase your CHIP Send Budget Allocation by converting an upcoming settlement amount. Upon initiation, all approvers will receive an email prompting them to approve the budget allocation.

*Note: All CHIP Send Budget Allocation requests must be approved by 12 PM MYT the following day. Any requests still pending at 12 PM MYT on the next day will be marked as expired.*


Increase Budget Allocation

Retrieve the details of a previously created send limit / budget allocation.

Retrieve send limit

List all send limits

Resends approval requests. Use this to resend pending approval emails to approvers.


Resend approval request

Add a bank account using the values provided in the parameters. Store the ID returned in the response, as it will be required for subsequent processes.


Add a bank account

Retrieve details of a recipient bank account that was previously created.


Retrieve a bank account

Deletes a bank account record, preventing future payments using the 'Create Send Instruction'.


Delete a bank account

Returns list of recipient bank accounts.


List all bank accounts

Resends webhook event of a bank account record.


Resend bank account webhook event

Create a send instruction using the values provided in the parameters. Calling this endpoint will reduce your available account balance and credit the amount to the receiver's bank account.


Create a send instruction

Retrieve details of a send instruction that was previously created.


Retrieve a send instruction

Deletes send instruction that have been previously created.

*Note: Only unprocessed instructions can be deleted; any other attempts will fail.*


Delete a send instruction

Returns a list of previously created send instructions.

*Note: This request is cached and will only refresh every hour.*


List all send instructions

Resends webhook event of a send instruction record.


Resend send instruction webhook event

Create a group using the values provided in the parameters.


Create a group

Retrieve details of a group that was previously created.


Retrieve a group

Update the specified group using the values provided in the parameters.


Update a group

Delete a group

Returns a list of previously created group records.

*Please note that this request is cached and will only refresh every hour.*


List all groups

Create a webhook using the values provided in the parameters.


Retrieve details of a webhook that was previously created.


Update the specified webhook using the values provided in the parameters.


Returns a list of previously created webhooks.

*Please note that this request is cached and will refresh every hour.*


Overview

API Reference

List all clients

Authorizations

Path Parameters

Response