Create a new client account. Client types include reseller and merchant.
The child client this request acts on behalf of. A reseller still authenticates as itself — Api-Key and Client-Id stay the reseller's — and names the child here.
This works only from a parent to its own children. Merchants have no children, so a merchant calling as itself omits the header. Sending your own client ULID here is not the same as omitting it, and is rejected on some operations.
Unique identifier of the parent client account (reseller or ISO).
The type of client account.
| Enum Value | Description |
|---|---|
| reseller | Reseller — a client that resells services to merchants. |
| merchant | Merchant — a client that processes payments. |
The client's addresses, one per type. The list must include the LEGAL address, whose street the gateway sends to the card processor as the merchant's address, and may add a BILLING and a PHYSICAL address. A type may not appear twice.
Phone number. The phone number must contain between 10 and 12 digits and can contain spaces, a leading + symbol (when used with a country code), and the special characters (, ), -, and .. Alphabetical characters are not allowed.
Phone number. The phone number must contain between 10 and 12 digits and can contain spaces, a leading + symbol (when used with a country code), and the special characters (, ), -, and .. Alphabetical characters are not allowed.
URL of client website. At most 30 characters, the width of the merchant URL field the gateway sends to the card processor.
Contact information for the primary admin user, supplied when creating a client. The four required properties must each carry a value — null is rejected, and so is an empty string.
Key-value pairs for storing additional information on the transaction. Send null to clear all metadata.
At most 50 keys. Keys may contain letters, digits, hyphens, and underscores, up to 40 characters. Values are strings up to 500 characters. Every limit below is enforced; a request that exceeds any of them is rejected.
{ "order_id": "ORD-10432", "sales_channel": "web", "customer_reference": "cust-8891" }
- Mock server (simulated responses)https://developer.paradisepayments.com/_mock/apis/openapi/v1/clients
{ "parent_id": "CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y", "type": "reseller", "dba": "Acme Jewelry", "address": [ { … } ], "primary_phone": "+18006555667", "support_phone": "+18005255656", "website": "https://www.acme.com", "admin_contact_details": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone": "+18005551234", "time_zone": "America/New_York" }, "metadata": { "order_id": "ORD-10432", "sales_channel": "web", "customer_reference": "cust-8891" } }
Client account created successfully
Unique identifier assigned to the request by the API server. Returned on every response, including errors. Log this value and supply it when contacting support so that a specific request can be traced.
Unique identifier for the newly created client assigned by the API server.
Unique identifier of the parent client account.
The type of client account.
| Enum Value | Description |
|---|---|
| reseller | Reseller — a client that resells services to merchants. |
| merchant | Merchant — a client that processes payments. |
Doing Business As (DBA) name of the newly created client.
One or more client addresses. Each address carries a type identifying its purpose (legal, billing, or physical).
Phone number. The phone number must contain between 10 and 12 digits and can contain spaces, a leading + symbol (when used with a country code), and the special characters (, ), -, and .. Alphabetical characters are not allowed.
Phone number. The phone number must contain between 10 and 12 digits and can contain spaces, a leading + symbol (when used with a country code), and the special characters (, ), -, and .. Alphabetical characters are not allowed.
URL of client website. Null when the client was created without one — the gateway returns the field rather than omitting it.
Contact information for the primary admin user of a client account, as returned on a response. The four required properties are always present and may be null, because a client created through an internal path is not held to the rules ClientAdminContactDetailsInput applies. A request uses ClientAdminContactDetailsInput to create and ClientAdminContactDetailsUpdate to amend.
API key issued for the new client. Returned once, on this response only — store it, because no later call returns it again.
Key-value pairs for storing additional information on the transaction. Send null to clear all metadata.
At most 50 keys. Keys may contain letters, digits, hyphens, and underscores, up to 40 characters. Values are strings up to 500 characters. Every limit below is enforced; a request that exceeds any of them is rejected.
{ "order_id": "ORD-10432", "sales_channel": "web", "customer_reference": "cust-8891" }
{ "id": "CLIENT-3MTWBWLKDIWHU7IX28A3TQPA", "parent_id": "CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y", "type": "reseller", "dba": "Acme Jewelry", "address": [ { … } ], "primary_phone": "+18006555667", "support_phone": "+18005255656", "website": "https://www.acme.com", "admin_contact_details": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone": "+18005551234", "time_zone": "America/New_York" }, "api_key": "pk_live_01KFDKXMQ637EKEAY410MSQSXB", "metadata": { "order_id": "ORD-10432", "sales_channel": "web", "customer_reference": "cust-8891" }, "correlation_id": "01KFDKXMQ637EKEAY410MSQSXB" }