# List Balance Transfers Retrieve a list of Balance Transfer resources. Endpoint: GET /balance_transfers Version: 2022-02-01 Security: BasicAuth ## Query parameters: - `amount` (integer) Filter by an amount equal to the given value. Example: 100 - `description` (string) Filter by the Description value . - `destination` (string) Filter by the Payment Instrument saved in Destination. - `external_reference_id` (string) Filter by the value saved in external_reference_id. - `idempotency_id` (string) Filter by Idempotency ID. Example: "15d32948-c766-4033-8d87-dfbdcabcbc5c" - `reference_id` (string) Filter by the value saved in reference_id. - `source` (string) Filter by the Payment Instrument saved in source. - `after_cursor` (string) Return every resource created after the cursor value. - `before_cursor` (string) Return every resource created before the cursor value. - `created_at.gte` (string) Filter where created_at is after the given date. Example: "2022-09-27T11:21:23" - `created_at.lte` (string) Filter where created_at is before the given date. Example: "2026-09-27T11:21:23" - `limit` (integer) The numbers of items to return. Example: 10 - `tags.key` (string) Filter by the tag's key. For more information, see Tags. Example: "card_type" - `tags.value` (string) Filter by the tag's value. For more information, see Tags. Example: "business_card" - `updated_at.gte` (string) Filter where updated_at is after the given date. Example: "2022-09-27T11:21:23" - `updated_at.lte` (string) Filter where updated_at is before the given date. Example: "2026-09-27T11:21:23" ## Header parameters: - `Finix-Version` (string) Specify the API version of your request. For more details, see Versioning. Example: "2022-02-01" ## Response 200 fields (application/json): - `page` (object) Details the page that's returned. - `page.limit` (integer) The number of entries to return. - `page.next_cursor` (string,null) The cursor to use for the next page of results. - `_embedded` (object) - `_embedded.balance_transfers` (array) - `_embedded.balance_transfers.id` (string) The ID of the resource. - `_embedded.balance_transfers.created_at` (string) Timestamp of when the object was created. - `_embedded.balance_transfers.updated_at` (string) Timestamp of when the object was last updated. - `_embedded.balance_transfers.amount` (integer) The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). Example: 5000 - `_embedded.balance_transfers.currency` (string) ISO 4217 3-letter currency code. Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" - `_embedded.balance_transfers.description` (string) Additional information about the Balance Transfer. Example: "Transferring funds for the Holidays" - `_embedded.balance_transfers.destination` (string,null) An aliased ID for the account where funds are credited. Enum: "FOR_BENEFIT_OF_ACCOUNT", "OPERATING_ACCOUNT" - `_embedded.balance_transfers.external_reference_id` (string) A unique identifier for this Balance Transfer that can be used to reconcile this transfer with your internal systems. - `_embedded.balance_transfers.processor_type` (string) Pass LITLE_V1; balance transfers are only available for platforms with LITLE_V1 credentials. Enum: "LITLE_V1" - `_embedded.balance_transfers.reference_id` (string) An ID generated by Finix. - `_embedded.balance_transfers.source` (string) An aliased ID for the account where funds are debited. Enum: "FOR_BENEFIT_OF_ACCOUNT", "OPERATING_ACCOUNT" - `_embedded.balance_transfers.state` (string) The state of the Balance Transfer. Enum: "CREATED", "SUBMITTING", "SUBMITTED", "SUCCEEDED", "FAILED", "RETURNED", "UNKNOWM" - `_embedded.balance_transfers.tags` (object,null) Include up to 50 key: value pairs to annotate requests with custom metadata. - Maximum character length for individual keys is 40. - Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales) - `_embedded.balance_transfers._links` (object) - `_embedded.balance_transfers._links.self` (object) Link to the resource that was used in the request. - `_embedded.balance_transfers._links.self.href` (string) - `_links` (object) - `_links.self` (object) Link to the resource that was used in the request. - `_links.self.href` (string) - `_links.next` (object) Link to the next page of entries. - `_links.next.href` (string) ## Response 401 fields (application/json): - `total` (integer, required) Total number of errors returned. - `_embedded` (object, required) Container for embedded error objects. - `_embedded.errors` (array) List of individual error objects. - `_embedded.errors.code` (string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request. - `_embedded.errors.logref` (string) A log reference identifier for the error, useful for debugging and support purposes. - `_embedded.errors.message` (string) A human-friendly error message. - `_embedded.errors._links` (object) Links related to this error. - `_embedded.errors._links.self` (object) Link to the resource related to the error. - `_embedded.errors._links.self.href` (string) URL of the related resource. ## Response 403 fields (application/json): - `total` (integer, required) Total number of errors returned. - `_embedded` (object, required) Container for embedded error objects. - `_embedded.errors` (array) List of individual error objects. - `_embedded.errors.code` (string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request. - `_embedded.errors.logref` (string) A log reference identifier for the error, useful for debugging and support purposes. - `_embedded.errors.message` (string) A human-friendly error message. - `_embedded.errors._links` (object) Links related to this error. - `_embedded.errors._links.self` (object) Link to the resource related to the error. - `_embedded.errors._links.self.href` (string) URL of the related resource. ## Response 406 fields (application/json): - `total` (integer, required) Total number of errors returned. - `_embedded` (object, required) Container for embedded error objects. - `_embedded.errors` (array) List of individual error objects. - `_embedded.errors.code` (string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request. - `_embedded.errors.logref` (string) A log reference identifier for the error, useful for debugging and support purposes. - `_embedded.errors.message` (string) A human-friendly error message. - `_embedded.errors._links` (object) Links related to this error. - `_embedded.errors._links.self` (object) Link to the resource related to the error. - `_embedded.errors._links.self.href` (string) URL of the related resource.