GET /virtual_bank_accounts

Lists all the virtual bank accounts.

Servers

Request headers

Name Type Required Description
chargebee-request-origin-device String No

The device from which the customer has made the request

chargebee-business-entity-id String No

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

chargebee-request-origin-user String No

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-ip String No

The IP address of the customer where the request originated

chargebee-request-origin-user-encoded String No

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

Query parameters

Name Type Required Description
customer_id Object No

optional, string filter
Identifier of the customer.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer_id[is] = "3bdjnDnsdQn"

limit Integer No

The number of resources to be returned.

Default value: 10

created_at Object No

optional, timestamp(UTC) in seconds filter
Timestamp indicating when this virtual bank account resource is created.
Supported operators : after, before, on, between

Example → created_at[after] = "1435054328"

offset String No

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

updated_at Object No

optional, timestamp(UTC) in seconds filter
Timestamp indicating when this virtual bank account resource was last updated.
Supported operators : after, before, on, between

Example → updated_at[after] = "1435054328"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.