Skip to main content
POST
Confirm an external bank payout for a ready customer account
Confirm a payout with preview_token + idempotency_key. On live this sends funds. Reuse the same idempotency key after network errors; re-preview if the token expired. Guide: External bank payouts.

Authorizations

X-API-Key
string
header
required

Path Parameters

customer_id
string
required

Public customer id returned by POST /partner/customers

Example:

"pcus_a1b2c3d4e5f6"

account_id
integer
required

Account id returned by the customer account API

Required range: x >= 1

Body

application/json

Confirm a previewed bank payout using the signed preview token.

preview_token
string
required

Token from payouts/preview

Minimum string length: 16
idempotency_key
string
required

Partner-stable id; same key returns the prior payout

Required string length: 8 - 64

Response

External bank payout accepted for processing.

status
enum<string>
required
Available options:
success
message
string
required
data
object
required