Skip to main content
POST
Transfer between two routable bank accounts

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
amount
string
required

Monetary amount as a decimal string with two decimal places (for example "100.00"). Must be positive.

Example:

"100.00"

source_entity_id
string
required

Identifier of the source entity. Matches source_entity_type: a user-* id when type is user, a buss-* id when business, or a prog-* id when program.

source_entity_type
enum<string>
required

Type of the source entity.

Available options:
user,
business,
program
source_routable_bank_account_id
string
required

Source routable bank account identifier. Must belong to the source_entity_id.

Example:

"rbac-2b1c0e44-4f2d-9a11-7b23-cc90d1ef8f3a"

destination_entity_id
string
required

Identifier of the destination entity. Matches destination_entity_type: a user-* id when type is user, a buss-* id when business, or a prog-* id when program.

destination_entity_type
enum<string>
required

Type of the destination entity.

Available options:
user,
business,
program
destination_routable_bank_account_id
string
required

Destination routable bank account identifier. Must belong to the destination_entity_id.

Example:

"rbac-2b1c0e44-4f2d-9a11-7b23-cc90d1ef8f3a"

description
string
required

Free-form description attached to the resulting transaction.

idempotent_key
string
required

Client-supplied idempotency token. Submitting the same key twice returns the first response rather than creating a duplicate transaction.

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

reference
string

Optional external reference string stored on the resulting transaction.

metadata
object

Arbitrary key/value metadata object attached to the operation.

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.