Skip to main content
POST
RTP payouts (rtp_credit) ended on October 30, 2026. FedNow (fednow_credit) replaces RTP for instant USD payouts. Requests that still send rtp_credit return 400 invalid_transfer_types on address creation or 400 invalid_transfer_type on transfer creation. To switch, follow Migrate from rtp_credit to fednow_credit. For recipient banks that do not participate in FedNow, use same_day_ach_credit or wire.

rtp_credit errors

A request with destination.transfer_type: "rtp_credit" returns 400:
Response (400)
Brale does not create a Transfer for this request. Add fednow_credit to the destination bank Address, then resend the payout with destination.transfer_type: "fednow_credit" and a new Idempotency-Key. See Migrate from rtp_credit to fednow_credit. Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Headers

Idempotency-Key
string
required

A unique string used to prevent duplicate operations. Each POST request must use a new idempotency key. Use a UUIDv4 string. Example: idemp-123e4567-e89b-12d3-a456-426614174000

Path Parameters

account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{27}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Body

application/json
amount
Amount · object
required

Monetary value with explicit currency

source
PaymentData · object
required
destination
PaymentData · object
required
brand
object | null

Optional branding for a transfer. Supported for ACH transfers (ach_debit, ach_credit, same_day_ach_credit), outbound wire payouts (destination.transfer_type: wire), and FedNow payouts (destination.transfer_type: fednow_credit). Not supported for rtp_credit. Branding does not change which Account funds the transfer (the Account in the request path), the source or destination, or destination.wire_memo. Omit brand to send the transfer unbranded. See Branded Transfers.

note
string

Free-form note stored on the transfer and returned as note. Maximum 255 characters. To set what the recipient sees, use wire_memo or ach_description instead.

Maximum string length: 255

Response

Transfer successfully created. Creation is not settlement. Track status until it reaches complete, canceled, or failed.

A money movement between a source and a destination. Returned by the create, get, and list transfer endpoints. The same shape is used everywhere a Transfer is exposed to API consumers.

id
string<ksuid>
Pattern: ^[a-zA-Z0-9]{27}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

status
enum<string>

Lifecycle stage of the transfer. compliance review means Brale holds the transfer for compliance review before sending it, for example when the amount is above a payment partner's transaction limit. From there it moves back to pending or on to processing, or is canceled. The value contains a space, not an underscore.

Available options:
pending,
compliance review,
processing,
complete,
canceled,
failed,
refunding,
refunded
Example:

"pending"

failure
TransferFailure · object | null

Structured failure details for a failed transfer. Usually null. Populated when status is failed and Brale has structured failure details for the transfer — most commonly for ACH returns, outbound wire returns, and other rail/provider failures. Clients should not assume failure is always present for every failed transfer; check for null before reading nested fields.

Example:

null

source
TransferEndpoint · object

One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like transaction_id and payment_details are populated by Brale as the underlying leg settles.

destination
TransferEndpoint · object

One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like transaction_id and payment_details are populated by Brale as the underlying leg settles.

amount
Amount · object

Monetary value with explicit currency

note
string | null

Optional free-form note attached to the transfer.

Example:

null

brand
object | null

The Account the transfer was branded as, or null when the transfer was not branded. Returned on the create, get, and list transfer endpoints. Use it to confirm that the brand you requested was applied. A transfer created with brand can still return null if Brale sent it unbranded.

Example:

null

created_by
TransferCreatedBy · object | null

Who created the transfer, or null when the creator is not one of the exposed types. Returned on the create, get, and list transfer endpoints, on the simulate Automation deposit response, and in the data object of transfer.completed and transfer.canceled webhooks.

Example:
automation_id
string<ksuid> | null

ID of the Automation that created this transfer, when applicable. Omitted for transfers created directly via the API.

Pattern: ^[a-zA-Z0-9]{27}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

funding_simulated
boolean

Optional. When returned with a value of true, the source funding for this transfer was simulated in testnet rather than coming from a real payment. Not every simulated transfer is guaranteed to include this field. Not present for production-funded transfers.

created_at
string<date-time>
Example:

"2026-01-01T00:00:00Z"

updated_at
string<date-time>
Example:

"2026-01-01T00:00:00Z"