Skip to main content
POST
Add a Bank Account

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Add a bank account as a payment method.

user_id
string<uuid>
required

Owner user UUID.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

account_holder_name
string
required

Name of the account holder.

Maximum string length: 120
Example:

"John Doe"

bank_account_number
string
required

Full bank account number.

Required string length: 4 - 34
Example:

"1234567890"

routing_number
string
required

ACH routing number (9 digits).

Required string length: 9
Example:

"021000021"

account_type
string | null

Account type (e.g. checking, savings).

Maximum string length: 30
Example:

"checking"

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.