We are currently integrating a custom payment method using Tap Payments within our SimplyBook.me setup. When a user logs in and initiates a package purchase, SimplyBook.me redirects to our custom payment processing page, where we receive a customer_id in the request payload.
To proceed with the payment, we need to retrieve the client’s full details (such as name, email, and phone number) using this customer_id, so we can pass them to Tap Payments as required by their API.
Could you kindly clarify the following:
Which API method should we use to fetch a client’s full information using their customer_id?
What credentials or parameters are required for this API call? For example, is the client_id, API key, secret key, or signature necessary?
Is there a working example or official documentation link that demonstrates this process?
We would appreciate your guidance so we can complete this integration smoothly.
To retrieve a client’s full information using the provided customer_id, you should use the following API method:
Get client by ID
Endpoint : GET /admin/clients/{id} Description : Returns client details by their ID.
Parameters :
id — integer, the client ID (in your case, the customer_id received in the request).
Headers required : X-Company-Login : your company login X-Token : your API token obtained during authentication
Response: Returns a ClientEntity object containing the client’s id, name, email, and phone.
Example HTTP request :
GET https://user-api-v2.simplybook.me/admin/clients/1
Content-Type: application/json
X-Company-Login: your_company_login
X-Token: your_api_token
If you need full details, you can refer to the official documentation here:
Please note that the API will return AccessDenied if your credentials do not have the necessary permissions, or NotFound if the client does not exist.
Let me know if you need any further clarification. We appreciate your support in making this integration seamless.