The absolute value of the total amount of funds to be transferred to or from the related bank. Always returned as a decimal string with the currency's full precision (e.g., "500.00" for USD), regardless of whether the request used `amount` or `baseAmount`.
applyInstantCredit boolean required
Whether to apply "instant credit" to the transfer. This allows funds to be made available to customer from the CaaS reserve account if they are available.
bankAccountId string required
The bank account used for the transfer. This also determines the bank rails used for the transfer.
createdAt string <date-time>required
When the transfer was created/initiated.
enterpriseId string required
The enterprise related to the transfer. Determined automatically by the walletId.
estimatedEffectiveOn string or null
<date>required The date when the transfer is expected to become "effective" or "posted" by the related bank. Without instant credit this will usually be either T+1 or T+4 depending on risk profile of the related enterprise and bank account. Null when not yet determined.
The ID of the transfer. This should be generated by the client (prefer v4, v5, or v7) because it also serves as the idempotency key. Using an automatically generated ID provides no idempotency guarantees.
instantCreditLiability boolean required
Whether the current transfer counts against the CaaS reserve for instant credit. Only applies to transfers that opted for applyInstantCredit and have not yet settled. Once settled, transitions to false.
An automatically generated memo used for matching with bank transfers. Informational only.
settledAt string or null
<date-time>required When the transfer was settled (posted by the bank). Null until status is settled.
The status of a transfer. `initiated` means newly created and not yet completed processing. `processing` means currently processing with bank providers with funds in flight. `settled` means funds successfully processed and no longer flagged as instantCreditLiability. `reversed` means a previously settled transfer was reversed by the processor. `failed` means an unrecoverable error occurred before settlement.
Allowed values: initiated processing settled reversed failed
transferDirection string required
The direction of the transfer. `in` is a deposit (funds from bank to wallet), `out` is a withdrawal (funds from wallet to bank).
Allowed value: in
transferType string required
The bank rails being used by the transfer. Inferred from the bankAccountId.
Allowed value: ach-us
The transaction ID correlated with wallet platform. Can also be used in GET requests as an identifier.
The wallet (Go Account) used as counterparty to the transfer. Also determines the related enterprise.