Create a group using the provided parameters. It serves as a tag for bank accounts. For example, `Vendor` or `Employee` tag.


Create a group

bearerAuth

CHIP API

Welcome to the CHIP Collect documentation

CHIP Collect API

Online purchases

Billing

Callbacks

Authentication

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

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. The webhook enables the recipient to receive notifications via email and callback url when selected events occur.


Create a webhook

Retrieve details of a webhook that was previously created.


Retrieve a webhook

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


Update a webhook

Delete a webhook

Returns a list of previously created webhooks.

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


List all webhooks

CHIP Collect

CHIP Send

Dashboard

Support

Blog

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

Send this request providing, at the very least, the `brand_id` and `currency` query parameters having the same values you'd use to create your Purchase. Be sure to use the same API key you'll create your Purchase with; it will define the test_mode setting used in the lookup.

In the response body you'll receive an object with `available_payment_methods` property containing the list of payment method names available to use with your Purchase (e.g. those codes can be used in `payment_method_whitelist` field or with `?preferred={payment_method}` option of `checkout_url`).

Please note that all lookup arguments must be provided via query parameters after the endpoint, e.g. the minimal call would be similar to: `GET /api/v1/payment_methods/?brand_id=75a76529-91c7-4d98-90a9-8a641d70ee52&currency=EUR`

List of payment methods

Create a template to issue repeated invoices from in the future, with or without a subscription.

BillingTemplate generates Purchase objects, either to issue one-time invoices or in a subscription.

It does so by copying over its' `PurchaseDetails`, one of its `BillingTemplateClient`-s and generating other fields from BillingTemplate's fields as necessary into a new `Purchase` object.

If `is_subscription` is `true`, it is considered to be a subscription's BillingTemplate. You will need to specify `subscription_*` fields like `subscription_period` when creating it and add BillingTemplateClient objects to its billing cycle (`POST /billing_templates/{id}/add_subscriber/`). After that the clients will receive recurring invoices (that will be paid for automatically if client saves their card) according to the BillingTemplate settings you have specified.

If `is_subscription` is `false`, this BillingTemplate is used to send one-time invoices. After creating it and specifying `invoice_*` fields, use `POST /billing_templates/{id}/send_invoice/` request to send the actual invoices. BillingTemplateClients for non-subscription BillingTemplates are not saved.

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

List all billing template clients for this billing template.


List all clients

Client is a record of a single customer of your business. Create one for each of your clients; you will be able to issue invoices/subscriptions for them later easily using `/billing_templates/` API.

Each BillingTemplateClient (there can be many attached to a single BillingTemplate) will bind a single Client to a BillingTemplate.

Create a client

Partially update a client

Delete a client

List recurring tokens saved for a client.

All of these tokens will be available in a checkout (see `Purchase.checkout_url`) if you create a Purchase with this client's ID in `client_id` field.

You can use one in `POST /purchases/{id}/charge/`, too. Note that you can use one client's `recurring_token` to pay a Purchase created for a different `client_id` or created with no `client_id` at all; it's not recommended to do this.

List recurring tokens

Retrieve a recurring token

If you create the Purchase with the respective Client's ID (in `.client_id`), he won't see this token as available on checkout page anymore.

You also won't be able to use the ID of this object as a `recurring_token` in `POST /purchases/{id}/charge/`. The respective Purchase will have `is_recurring_token` set to `false` (as if `POST /purchases/{recurring_token}/delete_recurring_token/` was issued).

Delete a recurring token

Create a webhook using the values provided in the parameters. The webhook enables the recipient to receive notifications via callback url when selected events occur.


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.

API Reference

Accounts

Send Limits

Bank Accounts

Send Instructions

Groups

Webhooks

Create a group

Authorizations

Headers

Body

Response