Get details for a specific customer
Are you looking for details about a specific customer? Use GET {URI}/customers/{customerIdentifier}
endpoint to get details:
Endpoint | Purpose |
---|---|
GET {URI}/customers/{customerIdentifier} | Get details for a specific customer on this platform. |
The following path parameter is used with this endpoint:
Path param | Data type | Description |
---|---|---|
customerIdentifier | string | A unique identifier for the customer under which you are seeking details. The string must have 5-100 characters. |
The following payload is an example for when you useGET {URI}/customers/{customerIdentifier}
:
{
"customerIdentifier": "string",
"displayName": "string",
"status": "string",
"createdAt": "2024-03-11T19:30:55.706Z",
"accounts": [
{
"accountIdentifier": "string",
"accountNumber": "string",
"displayName": "string",
"createdAt": "2024-03-11T19:30:55.706Z",
"status": "string",
"currencyCode": "string"
}
]
}
Here's an example payload for when you receive an error:
{
"timestamp": "2025-02-21T23:23:13.930Z",
"requestId": "string",
"path": "string",
"httpCode": 0,
"httpPhrase": "string",
"i18nKey": "string",
"message": "The error message will show here for error codes ",
"errors": [
{}
]
}
The possible response codes for this endpoint are:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 500 Internal Server Error
- 503 Service Unavailable
Updated 6 days ago