API Reference

Account CREATE

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.

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!