Payout to linked bank account

Sends an ACH payout from the Bakkt account {account_uuid} to the user's linked bank account. Balance is checked in GL before processing. To retry safely, send a merchant_transaction_id and reuse it on the retry, so the retry does not pay out twice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the Bakkt account to debit

Body Params

Pays out over ACH from the Bakkt account {account_uuid} in the path to the user's linked bank account. The user is identified by the session or user-uuid header.

number
required

Amount to send; must be positive with at most two decimal places

string
enum
required

Payout currency. Only USD is supported

Allowed:
uuid
required

UUID of the user's linked bank account, as returned by GET /accounts/user/linked-bank-accounts

string
length between 1 and 255

Optional unique id for this payout. A retry with the same value resolves to the same transaction instead of paying out twice. When omitted, each request is a new payout

string
length ≤ 500

Optional note stored with the transaction

Headers
string
length ≤ 255

Unique key per request, e.g. a UUID v4. A retry with the same key and the same body returns the original response with the Idempotent-Replayed: true header and does not run the request again. The same key with a different body returns 422 IdempotencyKeyMismatch; a retry while the first request is still running returns 409 IdempotencyInProgress. Keys are scoped to the authenticated caller and kept for 24 hours. Recommended on every retry of a request that moves money. Max 255 characters.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json