Getting started

The WorldFirst Developer Center is your integrated development environment for building, testing, and launching applications on the WorldFirst platform. Follow the steps below to complete your integration — from account setup to production launch.

Figure 1. WorldFirst integration lifecycle

The Developer Center is currently in pilot phase and not yet publicly available. Please reach out to the parties below to obtain your account credentials:

Read through the relevant documents in the WorldFirst Documentation Center to familiarize yourself with the overall workflow and core concepts before starting your integration.

Work with our Solution Architect team to define your integration scope — including which capabilities are required and which are optional. Reach out to Technical Support to get connected with a Solution Architect.

Log in to the Developer Center. Navigate to Integration Hub → Manage Applications, and click Create Application.

Name your application and select the API version for it.

Note that the selected API version cannot be changed after the application is created. We recommend reading Versioning beforehand to understand which version fits your needs.

Choose the API modules your application needs, then click Create.

Modules are grouped by capability area (Accounts, Payouts etc.). You can update your scope at any time after the application is created.

If you are unsure which module to choose, contact WorldFirst Technical Support.

Once the application is successfully created, click View to open the sandbox configuration page for your application.

On the Sandbox Setup page of your application, copy your core credentials:

Generate an RSA key pair to sign requests and verify responses. Refer to the Generate Key Pair guide for step-by-step instructions.

Once the key pair is generated, paste your public key under Key Management and click Save.

Click Add/Edit Module to open the module picker. You can browse and filter modules by category.

To select the API modules, you can select specific API endpoints per module, or simply select all APIs to toggle all endpoints for a module at once.

Click Save to apply the changes. Unselected APIs will not be accessible.

Prepare a publicly accessible HTTPS endpoint to receive event notifications. Your endpoint must meet the following criteria:

Click Add Webhook in the Webhooks section. Enter a Name, Webhook URL, and select at least one event type. Click OK to save.

Once configured, WorldFirst sends event notifications to your endpoint automatically. You can also use the Simulate Event function to test your endpoint before going live.

Once the modules and API scope were all set up, navigate to the Test Cases page by clicking Next.

For each test case group listed under the Integration Test Cases section, click Details → Execute.

In each of the test case page, select a Mock Rule, then click Start.

All test cases must pass before submitting a Go-Live request. The WorldFirst team will evaluate test case results during approval.

Troubleshoot the issue if test case failed. Common causes of failures include:

You can also test your integration using the WorldFirst Postman Collection, which provides pre-configured requests for all major API endpoints.

See the Postman Collection guide for import and setup instructions.

Once all test cases pass, click Submit to submit your Go-Live request.

You can monitor the request approval status in the Application Approvals tab.

The WorldFirst team will review your test results, scope, and webhook configuration. If your request is rejected, address the listed reasons and resubmit your request.

Generate a new RSA key pair to use for the production environment. Refer to the Generate Key Pair guide for instructions.

Go to Integration Hub → Manage Applications → View → Key Management. Paste your production public key into the input field and click Save.

When your Go-Live request is approved, your sandbox scope and webhook configurations are automatically synced to production.

To add or modify scope and webhooks after go-live, click Modify Scope to update your API scope and webhook endpoints.

Update your integration with your production credentials:

Once it's done, your application is live and ready to process real transactions.

Track your progress through the complete integration process.

How it works

Prerequisites

Step 1: Register a Developer Center account

Step 2: Read the integration guides

Step 3: (Optional) Draft an integration plan

Integration Steps

Step 1: Create an application

1. Select API version

2. Select API modules

Step 2: Set up sandbox

1. Retrieve sandbox credentials

2. Configure key management

3. Configure modules and API scope

4. Set up webhooks

Step 3: Complete API test cases

1. Run test cases

2. Test with Postman

Step 4: Submit Go-Live request

Step 5: Launch into production

1. Generate new RSA key pair

2. Configure production public key

5.3 Review production scope and webhooks

5.4 Retrieve production credentials and go live

Onboarding checklist