Skip to content
Last updated

Create a client account

Prerequisites

  • An existing reseller account with admin credentials (resellers create child accounts)
  • A valid API key with admin permissions — see Obtain API credentials

Step 1: Prepare account details

Gather the following information for the new client.

FieldRequiredDescriptionExample
dbaYesBusiness name (doing-business-as)Acme Jewelry
parent_idYesYour reseller client IDCLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y
typeYesmerchant or resellermerchant
admin_contact_details.first_nameYesAdmin's first nameJohn
admin_contact_details.last_nameYesAdmin's last nameDoe
admin_contact_details.emailYesAdmin's email addressjohn.doe@example.com
admin_contact_details.phoneYesAdmin's phone number+15551234567
admin_contact_details.time_zoneYesTime zoneAmerica/New_York

Supported time zones: America/Los_Angeles, America/Phoenix, America/Denver, America/Chicago, America/New_York, Pacific/Honolulu, America/Anchorage.

Step 2: Create the client

Send a POST request to /v1/clients.

curl -X POST \
  https://api.dev.paradisegateway.net/v1/clients \
  -H "Content-Type: application/json" \
  -H "APIKEY: YOUR-API-KEY" \
  -d '{
    "dba": "Acme Jewelry",
    "parent_id": "CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y",
    "type": "merchant",
    "admin_contact_details": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone": "+15551234567",
      "time_zone": "America/New_York"
    }
  }'

Step 3: Verify the response

A successful request returns a 200 response with the new client object.

{
  "id": "CLIENT-04MQACMEJWLRY8NP3KS2W6X9Z",
  "object": "client",
  "parent_id": "CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y",
  "dba": "Acme Jewelry",
  "type": "merchant",
  "admin_contact_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+15551234567",
    "time_zone": "America/New_York"
  },
  "correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Save the id value — you need it for creating users, integrations, and API keys under this client.

Step 4: Create a processor integration

Before the new merchant can process transactions, connect it to a payment processor with POST /v1/integrations.

For more information, see Supported processors.

Step 5: Create an admin user

Create a user account for the new client so someone can log in and manage it. See Obtain API credentials for details on creating users and retrieving API keys.

Next steps