v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Transfers API

Get transfer

🚧 Beta feature

This feature is currently in beta testing, and the final specification may still change.

Retrieve a single transfer object by its transfer ID. This allows you to check the current status and details of a previously created transfer.

🔑 Access with

Advanced access token with business-account-transfers.read

get/business-accounts/transfers/{businessAccountsTransferId}

Query parameters

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

The transfer object.