Get Started With Cosmopoints

Welcome to Cosmopoints!
This guide will help you get started with integrating your system as a Burn Partner, allowing you to transfer points to our Loyalty Partners.

If you get stuck or need assistance during this process, please do not hesitate to contact us.
Please follow the steps below:

1. Managed Account Setup

Cosmopoints can assign a dedicated account manager to help you get set up. If you have decided to go with this approach, you will not need to go through step 2 and step 3 below.

Cosmopoints will issue your organization a Client ID and a Client Secret per environment. These credentials will allow you to authenticate your organization, acquire an authorization token, and make API requests.

Note: Cosmopoints will deliver your credentials using a secure mechanism. Please store your credentials in a secure environment and limit access to authorized personnel.

2. Self-Service Setup

If you have decided to go with the self-service setup approach, it means you skipped step 1 above. Cosmopoints offers a secure self-service portal to set up your account.

Visit the Cosmopoints portal and click on Sign Up.
Enter the sign-up information.
Verify OTP sent to your email address.

Enter Business Name

After verifying your email, you'll be prompted to enter your business name. Please enter the legal entity name for your business.

Access the Portal

Once your business name is entered, you can log in to the portal.

3. Complete Company KYB

Profile Setup

After logging in, you may complete your Company Profile by filling in the required details, including company name, address, industry, etc.

Submit for KYB Verification

Submit your company profile data for Know Your Business (KYB) verification. Once KYB is submitted, you may not change the entered information until acceptance or rejection of your business profile.

Admin Review

The Cosmopoints team will review your profile submission, after which you may access all features in the portal. This process requires 1-3 business days.

4. Sandbox Environment

Once your KYB is approved, you'll be able to start working in Sandbox mode. Visit the API keys page to access your Client ID and environment secrets.

Sandbox Key

Aside from the Client ID, you will be assigned a Sandbox secret key via the portal in the API Keys section. These will allow you to test the integration in a non-production environment.

For detailed API specifications, endpoints, and request/response formats, please refer to our API Documentation

Please note to use the "sandbox" environment URL to access the sandbox environment. See screenshot below.

5. Production Environment

After completing your sandbox integration, you can request a production API key from the keys section in the portal. Our team will review the request and provide the production key if your system is ready to go live.

Now that your account is fully set up, you may start integration in the production environment. You can do so by following our API documentation and calling our production APIs using the Client ID and the production key retrieved from the portal.

Please note to use the "production" environment URL to access the production environment. See screenshot below.

6. Going Live

Once your integration is thoroughly tested in Sandbox Mode, you are ready to go live and allow point conversions to any of the brands in your Cosmopoints catalog.

7. Making API Requests

For a complete and detailed API specification, please refer to our API documentation.

Most typical API use cases follow the following order of API requests:

Authenticate

Start by making an API call to our Identity Management service (IDM) to retrieve an access token used for authentication and authorization for any subsequent calls. Make sure you include the acquired access token prepended by Bearer to the Authorization header

Retrieve Currencies

Make an API call to retrieve the list of currencies your organization is partnered with. Partnerships are established on demand by Cosmopoints team.

Issue Points

Finally, issue your users points with any partner. All transactions are stored on a centralized ledger and are included in the monthly settlement process between your organization and Cosmopoints.