Fund Transfers

GET /banking/fund-transfers

Group: Banking › Fund Transfers · Operation ID: fundTransfers

Returns a list of fund transfers. To match on a linked account, a legal entity, or a journal entry number, use POST banking/fund-transfers/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
fundTransferNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
transferDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isVoided — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isIntercompany — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
origin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalPaymentId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, fundTransferNumber, transferDate, transferAmount, currency, isVoided, isIntercompany, lastModifiedDate
Selectable: id, fundTransferNumber, name, description, transferDate, transferAmount, currency, isVoided, isIntercompany, origin, externalPaymentId, fromAccountName, toAccountName, entityName, toEntityName, lastModifiedDate

Response

200 Success

Under data, an array of fundTransfersRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the fund transfer.
`fundTransferNumber`	string or null	no	The fund transfer number, for example 'FT-71122'. Absent while none has been assigned.
`name`	string or null	no	The display name of the fund transfer.
`description`	string or null	no	A free-form description of the transfer.
`transferDate`	string (date) or null	no	The date the money moved. Format YYYY-MM-DD.
`transferAmount`	string (decimal) or null	no	The amount moved, in the transfer currency.
`currency`	string or null	no	The transfer currency. Format ISO 4217, for example 'USD'. transferAmount is in this currency.
`isVoided`	boolean or null	no	Whether the transfer has been voided. A voided transfer is kept for audit rather than deleted.
`isIntercompany`	boolean or null	no	Whether the transfer moves money between two legal entities rather than between two accounts of one entity. When true, toEntityId names the receiving entity.
`origin`	string or null	no	The system or process the transfer came from.
`externalPaymentId`	string or null	no	The identifier of this payment in the external system that initiated the transfer. It is not unique.
`fromAccountName`	string or null	no	The name of the account the money left.
`toAccountName`	string or null	no	The name of the account the money arrived in.
`entityName`	string or null	no	The name of the legal entity the transfer is posted under.
`toEntityName`	string or null	no	The name of the receiving legal entity on an intercompany transfer.
`lastModifiedDate`	string (date-time) or null	no	The date and time the fund transfer last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error