GET /business_entities/transfers

Returns a list of business_entity_transfer resources meeting all the conditions specified in the filter parameters below. By default, this list is sorted by created_at in descending order (latest first).
Tip

To retrieve a history of all the business entity transfers for a resource, pass the filter parameters active_resource_id[is] and resource_type[].

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

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
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`resource_type`	Object	No	Filter `business_entity_transfer` resources based on `resource_type`. Tip Use this filter along with `active_resource_id[is]` to retrieve the history of all the business entity transfers for a resource.
`resource_id`	Object	No	Filter `business_entity_transfer` resources based on `resource_id`.
`active_resource_id`	Object	No	Filter `business_entity_transfer` resources based on `active_resource_id`. Tip Use this filter along with `resource_type[]` to retrieve the history of all the business entity transfers for a resource.
`created_at`	Object	No	optional, timestamp(UTC) in seconds filter To filter based on Created At. Supported operators : after, before, on, between Example → created_at[on] = "1702022464"
`sort_by`	Object	No	optional, string filter Sorts based on the specified attribute. Supported attributes : created_at Supported sort-orders : asc, desc Example → sort_by[asc] = "created_at" This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
`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.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.