Creates a fund transfer.

POST /banking/fund-transfers

Group: Banking › Fund Transfers · Operation ID: createFundTransfer

The response contains only the new transfer's id. Read the record with GET banking/fund-transfers/:id.

entityId, fromAccountId, toAccountId, transferDate and transferAmount are required.

A fund transfer always has one 'from' line and one 'to' line. They are derived from the header rather than sent in the request, and GET banking/fund-transfers/:id returns them.

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.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createFundTransferInput.

Field Type Required Description
entityId string yes The legal entity to post the transfer under. See id on GET base/entities.
fromAccountId string yes The general-ledger account the money leaves. It must differ from toAccountId. See id on GET accounting/accounts/:id.
toAccountId string yes The general-ledger account the money arrives in. It must differ from fromAccountId. See id on GET accounting/accounts/:id.
transferDate string (date) yes The date the transfer takes place. Use format YYYY-MM-DD. It sets the posting period.
transferAmount string (decimal) yes The amount leaving the from-account, in the transfer currency. It must be greater than zero.
currency string no The currency of the transfer amount. Format ISO 4217, for example 'USD'. Omit to use the from-account's own currency. A value that does not match it fails with CURRENCY_MISMATCH.
toAmount string (decimal) no The amount actually received in the to-account, in that account's currency. Supply it for a cross-currency transfer. Omit to mirror the amount sent.
exchangeRate string (decimal) no The exchange rate applied between the two account currencies. It must be greater than zero.
status string no The payment status. Accepted values: 'recorded', 'inProgress', 'completed', 'voided', 'failed', 'noStatus', 'unknown'. Defaults to 'recorded'.
name string no A short name for the transfer, shown in listings.
description string no A free-form description of the transfer. It is copied onto both lines.
toEntityId string no The receiving legal entity, for a transfer between entities. Defaults to entityId. See id on GET base/entities.
origin string no The system or process the transfer came from.
externalUrl string no An absolute http or https link to the transfer in the originating system.
externalPaymentId string no The identifier of the payment in the source system this transfer settles.

Example:

{
  "entityId": "e8dc29b9-7e79-4709-bb32-95938bcb1bd1",
  "fromAccountId": "f50164c3-85e3-4dab-986e-3fdb39f8ecc1",
  "toAccountId": "9994c3ed-f812-44c1-9454-7f36b2bfb0fb",
  "transferDate": "2026-02-14",
  "transferAmount": "2500.00",
  "currency": "<currency>",
  "toAmount": "19.99",
  "exchangeRate": "19.99",
  "status": "<status>",
  "name": "February sweep",
  "description": "<description>",
  "toEntityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "origin": "<origin>",
  "externalUrl": "<externalUrl>",
  "externalPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Under data (createFundTransferOutput):

Field Type Required Description
id string yes The unique identifier for the created fund transfer.

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
INVALID_FIELD_VALUE 400
SAME_ACCOUNT 400
TRANSFER_AMOUNT_NOT_POSITIVE 400
INVALID_EXCHANGE_RATE 400
GROUPING_ACCOUNT_NOT_ALLOWED 400
ACCOUNT_CURRENCY_MISSING 400
CURRENCY_MISMATCH 400
ACCOUNT_ENTITY_MISMATCH 400
POSTING_PERIOD_NOT_OPEN 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses