Retrieve batch transfers
Call Retrieve a batch transfer API or List all batch transfers API to retrieve batch transfer details; and List all items within a batch API to retrieve batch transfer item details. Additionally, you can subscribe to Batch Transfers webhook events to receive any batch transfer status transitions. See Batch transfer statuses for more information.
Retrieve a batch transfer
Call Retrieve a batch transfer API to retrieve details of a batch transfer by specifying the batch transfer id.
A successful request will return a response in the same format as Create a batch transfer API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
List all batch transfers
Call List all batch transfers API to retrieve batch transfers based on specific conditions.
You can specify the status to filter batch transfers. You can also use the pagination parameters (page, page_size) to refine the results. The response will be in the same format as Create a batch transfer API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
List all items within a batch
Call List all items within a batch API to retrieve all items in a batch transfer by specifying the batch transfer id. See more details in Step 5 in Create a batch transfer.
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.