Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Accounts

Create an account

Creates a new account object.

When you create an account, we recommend to include the customer's country. Some transactions may fail if you do not include it, as this field is required for specific payment methods.

post/accounts

Request body

languagestring

Two-letter language code (<a href="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes">ISO 639</a>).

countrystring

Two-letter country code (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).

Example request

{
  "contact": {
    "first": "First",
    "last": "Last",
    "email": "first.last@domain.com",
    "company": "Company Name",
    "phone": "555-555-5555"
  },
  "language": "en",
  "country": "US",
  "lookup": {
    "custom": "customKey"
  }
}

Response

OK

accountstring

The unique account identifier.

idstring

The unique account identifier.

actionstring

The action performed by the API call.

resultstring

Indicates that the request has succeeded or failed.

Example response

{
  "account": "abcDEFgHiJklM1N-3OP9q",
  "id": "abcDEFgHiJklM1N-3OP9q",
  "action": "account.create",
  "result": "success"
}