BillingPaymentsCrypto
BillingPaymentsCrypto
  • Introduction
    • 👋 Welcome
    • ▶️ What you need to operate
    • 🔑 Sandbox environment credentials
    • 🔧 Postman Collection
  • About us
    • 🌐 About us
    • ✨ Use cases
    • 🛡️ Security and data ownership
    • 💲 Pricing
  • Examples by country
  • API Reference
  • Webhooks
LogoLogo
API Reference🏢accounts

Create a new account

POST
https://api-billing.koywe.com/V1/accounts
POST
/V1/accounts
1curl -X POST https://api-billing.koywe.com/V1/accounts \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "country_id": 1,
6 "contact_name": "string",
7 "contact_phone": "string",
8 "admin_email": "string",
9 "admin_password": "string",
10 "registration_legal_name_company": "string",
11 "registration_tax_id_code": "string",
12 "registration_tax_id_type": "string",
13 "registration_company_size": "string",
14 "registration_terms_of_use": 1,
15 "registration_type_use": 1,
16 "registration_additional_data": {}
17}'
Try it
201Created
1{
2 "account_id": "638"
3}
Was this page helpful?
Previous

Get a specific account

Next
Built with
Get a specific account

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
country_idintegerRequired

Country ID where the account is created, supported IDs are:
253 = Chile
89 = United States
66 = Colombia
80 = Mexico
83 = Perú

contact_namestringRequired
Contact name associated with the account that will be created.
contact_phonestringRequired

Contact phone associated with the account that will be created, format:
+56xxxxxxxxx = Chile
+1xxxxxxxxx = United States
+57xxxxxxxxxx = Colombia

admin_emailstringRequired
Admin email associated with the account that will be created.\ Valid for login.
admin_passwordstringRequired
Admin password associated with the account that will be created.\ Valid for login.
registration_legal_name_companystringRequired
Legal name of the company being registered.
registration_tax_id_codestringRequired
Tax ID code of the company being registered, format: \ xx.xxx.xxx-x for Chile
registration_tax_id_typestringRequired
Tax ID type of the company being registered, supported IDs are:\ CL-RUT = Chile RUT\ US-EIN = United States EIN\ US-SSN = United States SSN\ CO-NIT = Colombia NIT\ PE-RUC = Peru RUC\ MX-RFC = Mexico RFC
registration_company_sizestringRequired
Size of the company being registered.\ 1 = Micro\ 2 = Small\ 3 = Medium\ 4 = Large
registration_terms_of_useintegerRequired
Acceptance of the terms of use.\ 1 = Accepted
registration_type_useintegerRequired
Type use of the accounts being registered, supported IDs are:\ 1 = Billing
registration_additional_dataobjectRequired
Required for certain countries. Check individual fields for more information
registration_company_industry_sectorstringOptional
Industry sector of the company being registered.
account_configobjectOptional

Response

Your account is successfully created
account_idinteger or null
Returns the ID of the created account.

Errors

Admin email associated with the account that will be created.
Valid for login.

Admin password associated with the account that will be created.
Valid for login.

Tax ID code of the company being registered, format:
xx.xxx.xxx-x for Chile

Tax ID type of the company being registered, supported IDs are:
CL-RUT = Chile RUT
US-EIN = United States EIN
US-SSN = United States SSN
CO-NIT = Colombia NIT
PE-RUC = Peru RUC
MX-RFC = Mexico RFC

Size of the company being registered.
1 = Micro
2 = Small
3 = Medium
4 = Large

Acceptance of the terms of use.
1 = Accepted

Type use of the accounts being registered, supported IDs are:
1 = Billing

Bearer authentication of the form Bearer <token>, where token is your auth token.