Skip to main content
POST
Create book transfer

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Body

Request model for initiating a book transfer between internal accounts.

amount
required

Amount to transfer. Must be greater than 0.

fromBankAccountId
string<uuid>
required

Source internal bank account identifier.

toBankAccountId
string<uuid>
required

Destination internal bank account identifier.

currencyCode
string
default:USD

ISO 4217 alphabetic currency code (e.g. USD). Defaults to USD when omitted. Determines the minor unit precision of long BookTransferRequest.Amount.

idempotencyKey
null | string

Optional idempotency key for preventing duplicate transfers. Maximum length: 256 characters.

reference
null | string

Optional caller-supplied reference used to correlate this money movement with a payment record in the caller's own system. Stored against the money movement (with leading and trailing whitespace removed) and echoed back on the creation response and on the bank account transfers list. Not required to be unique and not used for deduplication: supply idempotencyKey to make a retry safe. Maximum length: 40 characters. Must not be blank or contain control characters.

Response

Transfer created successfully.

Response model for a money movement operation.

id
string<uuid>
required

Unique money movement identifier.

amount
object
required

Money movement amount.

date
string<date>
required

Money movement date.

fromBankAccount
object
required

Source bank account information.

network
enum<string>
required

Payment network: BOOK, ACH, RTP, or FED_NOW.

Available options:
BOOK,
ACH,
RTP,
FED_NOW
status
enum<string>
required

Money movement status.

Available options:
PENDING,
COMPLETED,
FAILED
toBankAccount
object
required

Destination bank account information.

reference
null | string

The caller-supplied reference from the request, echoed back unchanged. Null when the request omitted one.