The Create Customer endpoint is designed to establish a new customer entity based on the provided request body. Below is an explanation of its functionality, integration requirements, and detailed description of the endpoint parameters.
Overview
The endpoint accepts both common and custom parameters within the request body:
- Common Parameters: Standard parameters required for all customer creations.
- Custom Parameters: Additional fields specific to the integration, placed at the same hierarchical level as common parameters.
Custom Parameter Handling
- Custom parameters must be explicitly handled within the integration connector.
- Recommendation: Integrators should define and prepare these custom parameters during the initial integration setup.
- If necessary, custom parameters can also be introduced or modified after customer creation. However, subsequent changes must be updated manually within your Customer database.
Integration Flow
-
Implement Customer Creation:
- Integrate customer creation logic in the connector.
- Ensure the logic properly processes both common and custom parameters.
-
Add Providers to Customers:
- After initial setup in the connector, Toqio can link the newly integrated provider to new or existing customers.
- The admin portal supports adding new providers to customers but does not support editing existing providers.
-
Code Adjustments:
- Update integration connector code to accommodate any new or modified custom parameters.
- Ensure all custom parameter changes are effectively utilized by the integration logic.
Handling Secret Parameters
- Secret parameters must be obfuscated in any response to maintain confidentiality and security.
- Implement appropriate data masking techniques to ensure these sensitive parameters are not exposed.
Endpoint Body Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Unique identifier for the customer. |
apiKey | string | API key provided by the integration connector for secure authentication. |
providerConfigId | string | Identifier for the provider configuration used within the integration. |
provider | string | Name or type of provider associated with the customer creation request. |
| paymentProvider (object) | Object containing details specific to the payment provider: | |
↳ customerId | string | Identifier provided by the payment provider for customer reference. |
↳ paymentProviderType | string | Type/category of the payment provider (e.g., card issuer, payment gateway). |
↳ key | string | Key used for authentication or configuration with the payment provider. |
↳ loginId | string | Login or authentication ID provided by the payment provider. |
↳ hmacKey | string | Key used for HMAC-based authentication or validation processes. |
commercialName | string | Commercial or brand name of the customer for display and reference purposes. |
availableCurrencies | array of strings | List of currency codes (ISO 4217 format) available for transactions with this payment provider. |
Following these guidelines ensures a secure, flexible, and efficient customer creation process within your integration.