White-label configuration

Introduction

In order to quickly get set up with our white-labeling solution, we've provided examples of the necessary API's below as CURL commands that you can run to manage your white-label settings.

You will first need to obtain an access token from our authorisation service, details of which can be found here Access Tokens. It is required to have a scope containing "users" when obtaining your token to be able to access these APIs.

Setting white-labeling values

When you're ready to set your customised white-label values, you can run the CURL command below with the relevant properties amended to suit your preferences.

curl -X POST \
  -H "Authorization: Bearer {auth_token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Ocp-Apim-Subscription-Key: {subscription_key}" \
  -H "participantId: {participant_id}" \
  -d '{"participantId":{participant_id},"participantLogoUrl":"https://example.com/your_logo_url","navbarBackgroundColor":"{hex_value}","buttonBackgroundColor":"{hex_value}","buttonHoverColor":"{hex_value}","buttonTextColor":"{hex_value}","buttonBorderRadius":{radius_number}}' \
  https://test.api.ordopay.com/config/customisation/participant

Retrieving white-labeling values

Should you quickly wish to check what values you currently have set in our platform for your white-labeling preferences, you can run the CURL command below to quickly retrieve these values.

curl -X GET \
  -H "Authorization: Bearer {auth_token}" \
  -H "Accept: application/json" \
  -H "Ocp-Apim-Subscription-Key: {subscription_key}" \
  -H "participantId: {participant_id}" \
  https://test.api.ordopay.com/config/customisation/participant

Deleting white-label values

If for any reason you wish to delete the white-label values currently stored within our platform, you can run the below CURL command to quickly remove these from our platform. It is also worth noting that should you wish to update your white-label values, you must delete your existing settings first and then call our POST with your updated values.

curl -X DELETE \
  -H "Authorization: Bearer {auth_token}" \
  -H "Accept: application/json" \
  -H "Ocp-Apim-Subscription-Key: {subscription_key}" \
  -H "participantId: {participant_id}" \
  https://test.api.ordopay.com/config/customisation/participant