Open BankingB2B SuiteERP Integration
GuidesAPI ReferenceChangelog
Menu

Categories

Open BankingB2B SuiteERP Integration

  • GENERAL INFORMATION

    • Documentation guide
    • SingleView B2B Core APIs
    • Platform architecture
  • GETTING STARTED

    • Integration guide
    • Become a user
    • Prerequisites for Sandbox
    • Establishing secure connection
    • Authenticating your request
    • Making your first test api call
    • Prerequisites for production
    • Moving to production
  • AUTHENTICATION

    • Header parameters
    • Obtain access token
    • Generate signature
  • Data APIs

    • Account statement
    • Balance enquiry
    • IBAN verification
    • POS transactions
    • Raw statement
  • Payment APIs

  • SADAD

  • RESOURCES

    • POR Details
    • Error codes
  • API Archives


Prerequisites for Sandbox

Prepare your environment for testing and integration

Before you can begin testing the SingleView B2B API Suite, your organization must complete the required onboarding activities and obtain access to the sandbox environment.

The sandbox environment enables developers to explore API capabilities, validate authentication mechanisms, test request and response flows, and verify application behavior before moving to production.

Before You Begin

Ensure that the following prerequisites have been completed before attempting to connect to the sandbox environment.

Complete the Onboarding Process

Your organization must successfully complete the onboarding process and receive approval to access the SingleView platform.

This includes:

  • Submitting an API access request
  • Providing business and technical contact details
  • Defining intended use cases
  • Identifying required APIs and services

Obtain Sandbox Access

Once onboarding has been approved, the technical team will provision access to the sandbox environment.

You will receive:

  • Sandbox API endpoint URLs
  • Environment-specific credentials
  • Authentication requirements
  • Integration guidance and support information

Review the Documentation

Before beginning implementation, familiarize yourself with the available documentation, including:

  • Integration Guide
  • Authentication
  • Signature Generation
  • API Reference
  • Error Handling

A clear understanding of these topics will help accelerate integration and reduce implementation issues.

Prepare Your Development Environment

Ensure your development environment is ready to send and receive API requests.

Recommended tools include:

  • Postman or similar API testing tools
  • Command-line tools such as cURL
  • Development frameworks or SDKs used by your application
  • Secure storage for credentials and keys

Understand Authentication Requirements

All API requests must be authenticated before accessing protected resources.

Prior to testing, ensure you understand:

  • Access token generation
  • Request signing requirements
  • Required request headers
  • Security validation mechanisms

Detailed instructions are available in the Authentication and Signature sections of the documentation.

Network Connectivity

Verify that your systems can successfully communicate with the sandbox environment.

Ensure that:

  • Outbound HTTPS connections are permitted
  • Required network policies are configured
  • Firewall rules do not block API communication

Test Data Availability

The sandbox environment provides test data and simulated responses to support development and validation activities.

Depending on the services being integrated, sample data may be available for:

  • Account information
  • Statements
  • Balance enquiries
  • Payouts
  • Payroll transactions
  • SADAD services
  • MOI services

Refer to the relevant API documentation for supported test scenarios.

Validation Checklist

Before proceeding, confirm that you have:

✓ Completed onboarding and received approval

✓ Obtained sandbox credentials

✓ Received sandbox endpoint details

✓ Reviewed authentication requirements

✓ Prepared your development environment

✓ Verified network connectivity

✓ Reviewed relevant API documentation

Outcome

After completing these prerequisites, you are ready to establish a secure connection, authenticate your requests, and begin testing APIs within the SingleView sandbox environment.

Updated July 3, 2026

PreviousBecome a userNextEstablishing secure connection
Was this helpful?