Quick Start
Setting up an Falcon FX sandbox account and completing integration tests is a critical step in the API integration process, designed to ensure safety, accuracy, and efficiency before handling real money in a production environment.
You must complete all mandated test cases in the sandbox environment before your application can be approved and move to production.
This Quick Start generally explains the main ideas and key steps in creating a sandbox account and conducting tests. For the detailed step-by-step guide on WorldFirst integration, kindly refer to the WorldFirst Developer Center User Manual.
Before you begin
Before setting up your sandbox (testing) account with Falcon FX, make sure you have:
- Contact WorldFirst support team to gain access to the Developer Center
- Selected the Falcon FX product(s) based on your business scenario (MCP / RFQ / Dynamic Pricing / AnXin-Sell)
Integration steps
Follow the steps below to create your sandbox account:
Step 1: Create a Developer Center account
Once you receive the invitation email from WorldFirst to create your Developer Center account, click the link provided in the invitation email to set your account login credentials.
Step 2: Configure Your Sandbox Application
Log in to the WorldFirst Developer Center and create a "mock" application to start testing. The process involves:
- Create a New Application: Select the option to create a new app to get your unique Client ID.
- Configure Public Keys: Follow the on-screen steps to generate or upload your client-side public key. This is required for secure communication.
- Set a Notification URL: If your system needs to receive automatic updates from WorldFirst (e.g., "payment successful"), provide a URL for notifications.
- Configure Webhook Endpoint: Register your webhook endpoint URL in the developer portal and subscribe to the relevant Falcon FX webhook events (e.g., aifx.mcp.*,aifx.rfq.*,aifx.pricing.*,aifx.hedging.*).
Step 3: Product-specific Setup
Based on the Falcon FX products you are integrating, complete the product-specific configuration:
MCP Lock-Price
- Confirm lock-price mode and currency pairs with WorldFirst
- If using DirectDebit, complete pre-authorization setup
- Test the quote-create-confirm-settle flow
- Test the original-rate refund flow
RFQ Market-Price
- Choose settlement mode and complete pre-authorization if needed
- Test the quote-create-confirm-settle flow within the 30-second validity window
- Build retry logic for expired quotes
Dynamic Pricing
- Configure initial pricing rules via aifx/pricing/rules/create
- Test the pricing query API with different transaction contexts
- Verify that rule-based and AI-based modes return consistent API responses
AnXin-Sell Hedging
- Create a test hedging contract via aifx/hedging/contracts/create
- Wait for ACTIVEstatus via webhook
- Test settlement against the contract
- Monitor contract utilization
Step 4: Test the Integration
Once your sandbox application is configured:
- Access the Test Cases: On the "Application Management" page, click "View" to see available test scenarios.
- Run Simulation: Use the "Execute" button to simulate actions like creating lock-price orders, initiating RFQ quotes, or querying dynamic prices — without moving real money.
- Use Postman (Optional): You can import the WorldFirst Postman Collection to send test requests if needed.
- Verify Webhooks: Ensure your webhook endpoint correctly receives and processes Falcon FX event notifications.
Next Step
After completing all the required test cases, you can submit the go-live request and publish your application to the production environment. At this point, you are all set to Get started with WorldFirst APIs.
