Create payout detail

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

Overview

Create payout details (bank account) for a vendor. Each vendor can have at most one payout detail.

Example: Set up ACH payment details for a vendor so they can receive payouts.


Important Behaviors

  • 1:1 constraint: Returns 409 if the vendor already has payout details configured.
  • Routing number validation: Must be exactly 9 digits and pass ABA checksum validation.
  • Masked in responses: Routing and account numbers are masked (only last 4 digits shown) in all API responses.
  • Defaults to disabled: payout_method_status defaults to disabled. Must be explicitly enabled and authorized before payouts can be processed.
  • Webhook: Triggers the vendor_payout_detail.created webhook event.
Query Params
int32
required
Body Params
integer
required
string
required
length ≤ 255
string | null
string
required
length between 9 and 9
string
required
length between 4 and 17
string
enum
required
Allowed:
string
length between 3 and 3
string
length between 2 and 2
string
enum
Allowed:
string | null
enum
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