The Find Customer endpoint enables the retrieval of detailed information about an existing customer using their customer ID . Below is the detailed documentation for the endpoint, including handling custom parameters and descriptions of the response body parameters.
Endpoint Functionality
Toqio uses the Find Customer endpoint to request details of an existing customer. This request involves:
- Customer ID
In addition to common parameters, this endpoint can include custom parameters at the same hierarchical level. These custom parameters must be processed and returned by the integration connector.
Important: Secret parameters included in the response must be obfuscated to ensure security.
Custom Parameters
Once fully implemented in the integration connector, custom parameters can be returned within an additionalParams field.
Handling commercialName
commercialNameThe commercialName field differentiates the banking provider for each product in the account creation process. The logic for naming products is:
- If a partner product has a defined label, this label will be shown visually.
- If no label is available but the
commercialNameis provided, the product name will be formatted as:commercialName - Partner product code. - If neither a label nor a commercial name is provided, the product name defaults to:
Default product - Partner product code.
Response Body Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Unique identifier for the customer. |
apiKey | string | API key provided by the integration connector for secure authentication. |
provider | string | Identifier of the provider associated with the customer. |
superCustomerId | string | Identifier for the super customer entity. |
paymentProvider | object | 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 |
↳ key | string | Authentication or configuration key 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 used to differentiate banking providers. |
↳ availableCurrencies | array of strings | List of currency codes (ISO 4217) available for transactions with this provider. |
code | string | Response code indicating the status of the request. |
errorSeverity | string | Severity level of any errors encountered. |
message | string | Informational message providing additional context or error details. |
httpStatus | int32 | HTTP status code corresponding to the response outcome. |
requestId | string | Unique identifier for tracking and referencing the specific request. |
date | string | Timestamp indicating when the response was generated. |
Following these guidelines ensures a consistent, secure, and effective approach to customer data retrieval within your integration.