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

A record of one of `recurring_token`-s saved for a specific client. `id` of this object will be the same as the `recurring_token` saved.

Description of this token, if available. For card payments, this field will contain the masked card number.

Payment method used to create this token, e.g. `card`.

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

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.


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

To run payments in your application use `POST /purchases/`, request to register payments and receive the checkout link (`checkout_url`). After the payment is processed, gateway will redirect the client back to your website (take note of `success_redirect`, `failure_redirect`).

You have three options to check payment status: 1) use `success_callback` parameter of `Purchase` object; 2) use `GET /purchases/<purchase_id>/` request; 3) set up a Webhook using the UI or Webhook API to listen to `purchase.paid` or `purchase.payment_failure` event on your server.

Using `skip_capture` flag allows you to separate the authentication and payment execution steps, allowing you to reserve funds on payer’s card account for some time. This flag can also enable preauthorization capability, allowing you to save the card without a financial transaction, if available.

In case making a purchase client agrees to store his card for the upcoming purchases, next time he will be able to pay in a single click.

Instead of a redirect you can also utilize Direct Post checkout: you can create an HTML `<form>` on your website with `method="POST"` and `action` pointing to `direct_post_url` of a created Purchase. You will also need to saturate form with `<input>`-s for card data fields. As a result, when a payer submits their card data, it will be posted straight to our system, allowing you to customize the checkout as you wish while your PCI DSS requirement is only raised to SAQ A-EP, as your system doesn't receive or process card data. For more details, see the documentation on Purchase's `direct_post_url` field.

To pay for test Purchases, use `4444 3333 2222 1111` as the card number, `123` as CVC, any date/month greater than now as expiry and any (Latin) cardholder name. Any other card number/CVC/expiry not greater or equal than the current month will all fail a test payment.

Create a purchase

Retrieve a purchase

If you have a Purchase that payment is possible for, using this request you can guarantee that it won't be paid.

Cancel a pending purchase

Release funds reserved for a Purchase (`status == hold`). You can place a `hold` (authenticate the payment) using `skip_capture == true` when creating the Purchase and ensuring your client submits the payment form.

If this operation takes too long to be processed on the acquirer side - you will get a response with status code 200 and a Purchase object having `status` = `pending_release` in body (you will receive a corresponding Webhook callback too for a `purchase.pending_release` event). To be notified of a successful operation completion, please subscribe to `purchase.released` callback event - it will deliver an updated Purchase with `status` = `released`.

If fund release fails due to payment processing error, you will receive HTTP response code 400 with error code `purchase_release_error`. In this case, to get more details about the error, you should perform a `GET /purchase/` request for the Purchase you tried to release funds for. In `transaction_data.attempts[]` array (newest element first) you'll find the corresponding attempt with error code and description in `.error` parameter.

Release funds on hold

Capture funds reserved for a Purchase (`status == hold`). You can place a `hold` (authenticate the payment) using `skip_capture == true` when creating the Purchase and ensuring your client submits the payment form.

If this operation takes too long to be processed on the acquirer side - you will get a response with status code 200 and a Purchase object having `status` = `pending_capture` in body (you will receive a corresponding Webhook callback too for a `purchase.pending_capture` event). To be notified of a successful operation completion, please subscribe to `purchase.captured` callback event - it will deliver an updated Purchase with `status` = `paid`.

If capture fails due to payment processing error, you will receive HTTP response code 400 with error code `purchase_capture_error`. In this case, to get more details about the error, you should perform a `GET /purchase/` request for the Purchase you tried to capture. In `transaction_data.attempts[]` array (newest element first) you'll find the corresponding attempt with error code and description in `.error` parameter. By default the full amount is captured, the `amount` body param is optional.

Capture a previously authorized payment

Charge a purchase using a `recurring_token` provided in the request body. Its value should be an `id` of a Purchase that has `is_recurring_token == true`. This purchase will be paid using the same method (e.g. same card) as the one used to pay the `recurring_token` purchase.

If this operation takes too long to be processed on the acquirer side - you will get a response with status code 200 and a Purchase object having `status` = `pending_charge` in body (you will receive a corresponding Webhook callback too for a `purchase.pending_charge` event). To be notified of a successful operation completion, please subscribe to `purchase.paid` callback event - it will deliver an updated Purchase with `status` = `paid`. Alternatively, if charge fails, you will receive a `purchase.payment_failure` callback event.

If recurring charge fails due to payment processing error, you will receive HTTP response code 400 with error code `purchase_charge_error`. In this case, to get more details about the error, you should perform a `GET /purchase/` request for the Purchase you tried to charge. In `transaction_data.attempts[]` array (newest element first) you'll find the corresponding attempt with error code and description in `.error` parameter.

Charge a purchase using a saved token

Will set `is_recurring_token` to `false`. You won't be able to use this Purchase's ID as a `recurring_token` anymore. The respective ClientRecurringToken, if any, will also be deleted.

If this operation takes too long to be processed on the acquirer side - you will get a response with status code 200 a corresponding Webhook callback for a `purchase.pending_recurring_token_delete` event. To be notified of a successful operation completion, please subscribe to `purchase.recurring_token_deleted` callback event.

Delete a recurring token associated with a purchase

Will generate a Payment object and return it as a successful response.

Optional `amount` argument can be included in the request body to request a partial refund.

Consult `refund_availability` field on Purchase on details whether this Purchase can be refunded or not.

If this operation takes too long to be processed on the acquirer side - you will get a response with status code 200 and a Purchase object having `status` = `pending_refund` in body (you will receive a corresponding Webhook callback too for a `purchase.pending_refund` event). To be notified of a successful operation completion, please subscribe to `payment.refunded` callback event - it will deliver a Payment generated by this refund.

If refund fails due to payment processing error, you will receive HTTP response code 400 with error code `purchase_refund_error`. In this case, to get more details about the error, you should perform a `GET /purchase/` request for the Purchase you tried to refund. In `transaction_data.attempts[]` array (newest element first) you'll find the corresponding attempt with error code and description in `.error` parameter.

Refund a paid purchase

Will set the purchase's status to `paid`. `purchase.marked_as_paid` field will also be set to true to distinguish this 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

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

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.

Overview

API Reference

List recurring tokens

Authorizations

Path Parameters

Response