Create payout

POST 
/payment/v3/payouts

Creates a payout. There is no request-side method: BVNK infers whether the payout is crypto or fiat from beneficiary.paymentInstrument.type (CRYPTO_ADDRESS or BANK_ADDRESS), so send it on every create request. method is still returned on responses and webhooks. Behaviour depends on payload completeness, not on a flag:

• No destination currency: returns an unpriced payout (PENDING_QUOTE_ACCEPTANCE) plus checkout.currencyOptions[].
• Destination currency and paymentInstrument.network but no paymentInstrument.address: returns a priced payout (PENDING_QUOTE_ACCEPTANCE) that cannot be sent yet.
• Everything, including the destination address or bank account: BVNK prices the payout as a quote, accepts it for you, and sends the payout (PROCESSING).
• Everything, plus confirmationRequired: true: BVNK prices the payout and accepts the quote, then holds it in PENDING_VERIFICATION until your customer confirms it. The payout is not sent until then, and expires at expiresAt.

Exactly one of originator.amount, beneficiary.amount, or checkout.amount may be set; BVNK derives the other two on every reprice.

Request

Responses

• 201
• 400

Payout created. Its status tells you whether it was sent, held for verification, or is still an unpriced or priced quote.