Get Started with Customer Profile API
Customer Profile API
Learn how to use the Customer Profile API to create profiles for your Singapore or Indonesia users.
Overview
The Customer Profile API allows you to create customer profiles for your users. These customer profiles are used as identifiers for us to create virtual account payment methods for your users. This allows you to accept payments of up to S$200,000 per SGD transaction (no limit for USD transactions).
Step 1 — Get your API keys
- Complete the verification process on the StraitsX Business Dashboard by submitting the relevant documents.
- You can retrieve your Sandbox API keys on the Sandbox Developer Tools Page. (See more)
- This API key will be used as an identifier and allow you to easily link profiles to your platform.
- You will need your X-XFERS-APP-API-KEY to create a customer profile.
Still awaiting verification? Contact our Support team to generate a sandbox API key to start testing.
Customer Profiles for New Users
Learn how to onboard your users to the Customer Profile Flow
Step 2 — Create a customer profile
Collect the necessary customer profile information from your users on your platform and proceed to create a customer profile for your personal and/or business users.
| Customer Profile Type | Parameters required for SGD transactions | Parameters required for USD transactions |
|---|---|---|
| Business | customerName registrationType (business) registrationId (UEN) | customerName registrationType (business) registrationId (UEN) registrationIdType registrationIdCountry address placeofBiz placeofBizCountry countryOfIncorporation dateOfIncorporation |
| Personal | customerName registrationType (personal) registrationId (NRIC/Passport No.) | customerName registrationType (personal) registrationId (NRIC/Passport No.) registrationIdType registrationIdCountry address countryOfResidence dateOfBirth nationality |
- Collect your user's personal details to generate a
customer_profile_id. - This information can be collected either via a form or via SingPass
- Note that in order for the created customer profile to have access to USD-related capabilities, you need to provide more user data in accordance with the requirements above. For existing customer profiles, you can use the
PATCHendpoint to submit additional user data.
Next step — Accepting Payments / Sending Payouts
And that's it! You're all ready to use the Payment API and Payout API to accept payments and send payouts to your users.
Try it out!
Getting started with StraitsX APIs is easy. Our business development and integration teams will be with you every step of the way. If you have any questions or would like to connect with our team, please do so via Support!
Updated 10 months ago