Create payout detail

post

https://www.pelcro.com/api/v1/core/vendors/payout-details

Create payout details (bank account) for a vendor.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

vendor_id

integer

required

The vendor user ID to create payout details for.

account_holder_name

string

required

length ≤ 255

Name on the bank account.

bank_name

string | null

Name of the bank.

routing_number

string

required

length between 9 and 9

9-digit ABA routing number. Must pass ABA checksum validation.

account_number

string

required

length between 4 and 17

Bank account number. 4 to 17 digits.

account_type

string

enum

required

Bank account type.

Allowed:

currency

string

length between 3 and 3

3-letter currency code (e.g. usd).

country

string

length between 2 and 2

2-letter country code (e.g. US).

payout_method_status

string

enum

Payout method status. Defaults to disabled.

Allowed:

authorization_method

string | null

enum

Authorization method for the payout.

Allowed:

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Overview

Important Behaviors

201Created.

400Invalid request.

401Unauthenticated.

409Conflict.