CHIP API

CHIP Collect

CHIP Send

Dashboard

Support

Blog

Retrieve a webhook

Available event types and when they are emitted:

`purchase.created`: Emitted when a Purchase is created. This happens as a result of POST /purchases/ request executed successfully or of any of the Billing API methods, including scheduled billing run by a BillingTemplate with is_subscription = true. Purchase.status will be == `created` in the received payload.

---

`purchase.paid`: Emitted when a Purchase is paid for. Purchase.status will be == `paid`. Happens when a payform is submitted (for a Purchase having `skip_capture == false`) and a successful payment is done by the payer or in case of /capture/ or /charge/ API requests executed successfully.

---

`purchase.payment_failure`: Emitted when payer submits a payment using the payform, but it doesn't complete successfully (e.g. because payer's account balance is insufficient). Purchase.status will be == `error`.

---

`purchase.pending_execute`: Emitted when transaction execution takes longer than expected on the acquirer side. See `pending_execute` Purchase status. When transaction becomes finalized, a `purchase.paid`, `purchase.hold` or `purchase.payment_failed` callback will be emitted.

---

`purchase.pending_charge`: Emitted when transaction execution takes longer than expected on the acquirer side. See `pending_charge` Purchase status. When transaction becomes finalized, a `purchase.paid` or `purchase.payment_failed` callback will be emitted.

---

`purchase.cancelled`: Emitted once POST /purchases/{id}/cancel/ request succeeds. It won't be possible to pay for the related Purchase after that. Purchase.status will be == `cancelled`.

---

`purchase.hold`: Emitted when a Purchase having `skip_capture == true` has its payform submitted and "payment" performed successfully. The specified amount of funds will be placed on hold. Purchase.status will be == `hold`.

---

`purchase.captured`: Emitted when the POST /purchases/{id}/capture/ request for a Purchase that previously had the status of `hold` succeeds. Purchase.status will be == `paid`.

---

`purchase.pending_capture`: Emitted when transaction execution takes longer than expected on the acquirer side. See `pending_capture` Purchase status. When transaction becomes finalized, a `purchase.captured` callback will be emitted.

---

`purchase.released`: Emitted when the POST /purchases/{id}/release/ request for a Purchase that previously had the status of `hold` succeeds. Funds reserved will be released with no payment performed. Purchase.status will be == `released`.

---

`purchase.pending_release`: Emitted when transaction execution takes longer than expected on the acquirer side. See `pending_release` Purchase status. When transaction becomes finalized, a `purchase.released` callback will be emitted.

---

`purchase.preauthorized`: Emitted when preauthorization scenario (see description for the Purchase.skip_capture field) is executed successfully. Purchase will have a status of `preauthorized`.

---

`purchase.recurring_token_deleted`: Emitted when the POST /purchases/{id}/delete_recurring_token/ request is executed successfully, deleting the recurring token associated with a Purchase. Purchase status will be the same as it were prior to this event.

---

`purchase.pending_recurring_token_delete`: Emitted when token deletion takes longer than expected on the acquirer side. When operation is finalized, a `purchase.recurring_token_deleted` callback will be emitted.

---

`purchase.subscription_charge_failure`: Emitted when an attempt to charge some Client's subscription-generated Purchase, using the token (e.g. card) they saved for their subscription, fails. Can only be emitted for a Purchase spawned from a BillingTemplate having is_subscription == true. Usually means the system can't charge the subscriber Client's card because e.g. their account balance is insufficient or card is expired, hence an invoice to be paid manually will be automatically mailed to them. Purchase.status in the returned payload will be == `sent`.

---

`purchase.pending_refund`: Emitted when refund transaction execution takes longer than expected on the acquirer side. See `pending_refund` Purchase status. When refund becomes finalized, a `payment.refunded` callback will ne emitted.

---

`payment.refunded`: Emitted when a Purchase is refunded (as a result of POST /purchases/{id}/capture/ request done successfully or action performed in company's frontoffice system). The returned data will be a Payment object generated as a result of this action. A link to the original Purchase (that will have a status of `refunded`) will be present in the `related_to` field of this Payment.

---

`billing_template_client.subscription_billing_cancelled`: Emitted when a subscriber represented by this event's related BillingTemplateClient cancels their subscription using an email link available in the receipts he receives. The respective BillingTemplateClient will have its `status` set to `subscription_paused` as a result.

---

`payout.pending`: Emitted when Payout execution has been initiated and is currently processing.

---

`payout.failed`: Emitted when a Payout processing was completed with an error. Payout.status will be == `error`. Note that payouts can spend up to 3-5 days (depending on the payout provider) in processing after being initiated.

---

`payout.success`: Emitted when a Payout is successfully processed. Payout.status will be == `success`. Note that payouts can spend up to 3-5 days (depending on the payout provider) in processing after being initiated.

PEM-encoded RSA public key for authenticating webhook or callback payloads

bearerAuth

Defines a webhook rule to an external server. The `callback` URL will receive a POST request with the related object's (e.g. Purchase for `purchase.*` webhooks) data in body when any of the events (see the description of `events` field below) it is configured to listen for are triggered.
The payload object will additionally include an "event_type" field to indicate which event type (see the Webhook.events field) triggered the webhook.

 Note that, as well as with the rest of dataset, test and live Webhooks are separate; test webhooks will not handle events caused by live Purchases, and vice-versa.

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

List all billing template clients for this billing template.


List all clients

Create a client

Partially update a client

Delete a client

List recurring tokens

Retrieve a recurring token

Delete a recurring token

Create 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

Retrieve a webhook

Authorizations

Path Parameters

Response