Account CREATE

post https://example.com/v2/account

Creates an account for you merchant

This call will create an account in the payments system and the processors system. It will also make the account accessible through the payment portal. Please note, the company name and country need to be correct. The country cannot be changed and if it's incorrect, the account will need to be deleted and a new account will need to be created.

This call will also handle setting up the default rates for the account.

An account represents a merchant, store or business that is using your software to do business. You need to create an account for each one of these entities that will be using your service to process cards through this payments API.

external_account_id is your unique identifier for this merchant using this account and is required to be unique and should be a uniquely identified in your system. The external_account_id must be at least 3 characters long.

user will be the initial user created for the account and will have admin access to all functionality in the portal. This first user should be someone trusted to manage payments for the company. Additional users can be created through the portal with different/limited permissions by this user.

processor is optional and allows you to specify the processor you want use for this account. Unless you are explicitly testing or need to specify a different processor, you should not send the processor but allow the system to use the default that is set for your account.

NOTE: Once an account is created, it's not yet usable for payments until it has been verified. The owner of the account will need to either log into the portal and follow the verification process or follow the link in the email that will be sent to them automatically.

Body Params

Account Params

name

string

required

length ≤ 50

This should be their official company name

external_account_id

string

required

length ≤ 100

Your unique identifier for the merchant/business/store in your system that will map to the payment account

two_letter_country_code

string

required

Defaults to US

2-letter country code

mcc

string

required

The MCC code needs to be set for your customers type of business. See the following URL for a list of codes:

https://stripe.com/docs/connect/setting-mcc#list

processor

string

Allows you to specify which processor to use for this account. This will default to your account settings.

user

object

required

statement_descriptor

string

length ≤ 22

Defaults to The company

This is the statement descriptor that will show up on the customers credit card statement. It will be truncated to 22 characters.

live_mode

boolean

Defaults to true

If this is set to false, then the company will be created for testing

skip_welcome_email

boolean

Optional, defaults to false. Allows the caller to handle sending the email on their own. If true, the user object in the response will contain an additional user_login_link object that may be sent to the user in place of the default welcome email.

rate_type

string

Allows specifying what type of rate is used for processing payments with this account. This field is optional and is only needed when specifying cash_discount as the process rate type.
Adyen Only: Cash discounting is only available with Adyen as the processor and allows sending a payment total that includes a fee for card processing (if the customer pays with cash, their amount will be discounted for not using a card).

non_cash_card_rate

string

Adyen Only: If the rate_type for the account is "cash_discount" this field is required and is the expected percent of the total of any POS payment that will be the card fee. We will not be calculating fees for POS payments on this account and it will be your responsibility to pass the fee amount with each POS payment request. However, this amount is used as a check to see if your fee amounts on each payment are within 5% of percent calculated by this amount.
For Example, let's say this amount is 2.5 and you have a payment with an amount of 20, we'd expect that your non_cash_adjustment on the payment would be 0.50. However, we will allow for a variance of 5 percent in this amount so it actually could be as low as 0.46 and as high as 0.53.
Please note that the value must be > 1 and <= 10 and is a human readable percent and not a fractional percent like 0.025.

business_phone

string

This is the phone number for the merchant/store/business

business_address

object

Represents address information

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://example.com/v2/account \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "two_letter_country_code": "US",
8
  "statement_descriptor": "The company",
9
  "live_mode": true
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Account create result

400invalid input, object invalid

401Unauthorized