Create Company

post

https://test.api.promisepay.com/companies

Create a Company associated with the User using a given user_id. Note: Some parameters are required for user verification. See our guide on Onboarding a Payout User/Seller for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Defaults to ABC

Company name

legal_name

string

required

Defaults to ABC Pty Ltd

Company legal name

tax_number

string

required

Defaults to 123456789

ABN / Tax number

business_email

string

≤ 40

The business email address associated with the user or business.Must be a valid email format (e.g., [email protected]). This email is used forofficial communication and account-related notifications. Disposable orpersonal email addresses are not recommended.

charge_tax

boolean | null

Charge GST or not? allowed values are true or false

address_line1

string

Address line 1

address_line2

string

Address line 2

city

string

City

state

string

State

zip

string

Zip

country

string

required

Defaults to AUS

3 digit country code (eg. AUS)

phone

string

Company phone number

user_id

string

required

Defaults to buyer-70729325

User ID to associate with the company

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

201OK