Update payout detail

Update a vendor's payout detail.

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

Overview

Update a vendor's payout detail (bank account information). All fields are optional.

Example: Update a vendor's bank account holder name or switch from checking to savings.


Important Behaviors

  • Routing number validation: If provided, must be exactly 9 digits and pass ABA checksum validation.
  • Masked in responses: Routing and account numbers are always masked in responses (last 4 digits only).
  • Audit logged: All changes are recorded in the audit log.
  • Webhook: Triggers the vendor_payout_detail.updated webhook event.
Path Params
int32
required

The payout detail ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
length ≤ 255

Name on the bank account.

string | null

Name of the bank.

string
length between 9 and 9

9-digit ABA routing number.

string
length between 4 and 17

Bank account number. 4 to 17 digits.

string
enum

Bank account type.

Allowed:
string
length between 3 and 3

3-letter currency code.

string
length between 2 and 2

2-letter country code.

string
enum

Payout method status.

Allowed:
string | null
enum

Authorization method.

Allowed:
Headers
string
required
Defaults to Bearer eyJ***
Responses

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