Get Fund Transfer

GET /banking/fund-transfers/{id}

Group: Banking › Fund Transfers · Operation ID: getFundTransfer

Returns the fund transfer with the given identifier. Use the fund transfer's id, not its fundTransferNumber.

A fund transfer moves money between two accounts. lines contains one line per side, each tagged with its accountType. On an intercompany transfer the two sides belong to different legal entities, and toEntityId names the receiving one.

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.
id path string yes The unique identifier for the fund transfer to return.

Response

200 Success

Under data (getFundTransferOutput):

Field Type Required Description
id string yes The unique identifier for the fund transfer.
fundTransferNumber string no The fund transfer number, for example 'FT-71122'. Absent while none has been assigned.
name string no The display name of the fund transfer.
description string no A free-form description of the transfer.
transferDate string (date) yes The date the money moved. Format YYYY-MM-DD.
transferAmount string (decimal) no The amount moved, in the transfer currency.
currency string no The transfer currency. Format ISO 4217, for example 'USD'. transferAmount is in this currency.
exchangeRate string (decimal) no The exchange rate applied when the two accounts are held in different currencies.
isVoided boolean no Whether the transfer has been voided. A voided transfer is kept for audit rather than deleted.
isIntercompany boolean 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.
journalEntryNumber string no The number of the journal entry this transfer posted to, on GET accounting/journal-entries. Absent until the transfer has posted.
origin string no The system or process the transfer came from.
externalUrl string no An absolute http or https link to the source document in an external system.
externalPaymentId string no The identifier of this payment in the external system that initiated the transfer. It is not unique.
fromAccountId string no The general-ledger account the money left. See id on GET accounting/accounts/:id.
fromAccountName string no The name of the account the money left.
toAccountId string no The general-ledger account the money arrived in. See id on GET accounting/accounts/:id.
toAccountName string no The name of the account the money arrived in.
entityId string no The legal entity the transfer is posted under. On an intercompany transfer this is the sending entity. See id on GET base/entities.
entityName string no The name of the legal entity the transfer is posted under.
toEntityId string no The receiving legal entity on an intercompany transfer. Absent on a same-entity transfer. See id on GET base/entities.
toEntityName string no The name of the receiving legal entity on an intercompany transfer.
lastModifiedDate string (date-time) yes The date and time the fund transfer last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object no The two sides of the transfer, one line per side. Read accountType to tell them apart rather than relying on order.
lines[].id string yes The unique identifier for the line.
lines[].lineNumber string no The line number.
lines[].accountType string yes Which side of the transfer this line is. Possible values: 'from', 'to'.
lines[].description string no A free-form description of the line.
lines[].amount string (decimal) no The line amount, in the line currency.
lines[].currency string no The currency of the line. Format ISO 4217, for example 'USD'. It differs from the transfer currency only on a cross-currency transfer.
lines[].bankFee string (decimal) no The bank fee charged on this side of the transfer, in the line currency.

Errors

Code Status
NOT_FOUND 400

Statuses