How To Register

Before calling any Global Collections API, the Merchant must activate the service and obtain API credentials on the Merchant Portal.

Step 1: Log in to the Merchant Portal.

Step 2: On the right pane, choose the Global Collections service, click the START REGISTRATION button, then click SUBMIT on the confirmation popup.

Step 3: Complete the Merchant KYB review. NeoX (with the partner provider) verifies the master merchant before the service is enabled.

Step 4: Retrieve the API integration credentials.

• Open the Profile section on the Merchant Portal.

• Copy the client_id and client_secret — these are used by the API authenPlatform endpoint to obtain a Bearer token.

Step 5: Configure the webhook to receive event notifications (recommended).

• Enable Use APIs.

• Fill in the URL to receive notifications for Global Collections events.

• Fill in the Secret Key — used to verify the secureHash of each webhook payload.

• Select the event Type(s) to subscribe to. See Event Notification.

Step 6: Generate the encryption key pair for sensitive payloads (if applicable).

• Generate an RSA key pair and upload the public key on the Merchant Portal.

• Keep the private key secret — it is used to decrypt any sensitive data returned by the service.

Once the service is ACTIVE and credentials are issued, proceed to Security Method.