Skip to main content
POST
Top up the program routable account from a program-level linked account

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
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

amount
string
required

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

Example:

"100.00"

account_id
string
required

Linked bank account identifier used as funding source.

routable_bank_account_id
string
required

Target routable bank account identifier.

Example:

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

api_key
string

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

idempotent_key
string

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

reference
string

Optional external reference string stored on the resulting transaction.

description
string

Free-form description attached to the resulting transaction.

source_ledger_account_uid
string

Named ledger account uid to debit as the operation source.

destination_ledger_account_uid
string

Named ledger account uid to credit as the operation destination.

source_name
string

Display name of the funding source (for receipts and webhook events).

descriptive_purpose
string

Short description of the transaction purpose surfaced to downstream processors.

participant_id
string

External participant identifier tracked with the transaction.

Response

Success.

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

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.