Open BankingB2B SuiteERP Integration
GuidesChangelog
Menu

Categories

Open BankingB2B SuiteERP Integration


  • GENERAL INFORMATION

    • Documentation guide
    • Documentation guide
    • SingleView B2B Core APIs
    • SingleView Open Banking
    • Platform architecture
    • KSAOB standards
    • Security best practices
  • Getting started

    • Introduction
    • Become a User
    • Quick Lookup
  • GETTING STARTED

    • Integration guide
    • Become a user
    • Integration guide
    • Prerequisites for Sandbox
    • Developer console
    • Establishing secure connection
    • Establish secure connection
    • Authenticating your request
    • Generate access token
    • Making your first test api call
    • Make test raw data API call
    • Prerequisites for production
    • Make test data use case API call
    • Moving to production
  • Authentication

    • Generate Signature
  • ERP API Services

    • Configure API Account
    • Create Group & Company
    • Supplier Services
    • Account Services
    • Balance Enquiry
    • Statements
    • IBAN Validation
    • POS Transactions
  • CONSENT MANAGEMENT

    • Overview
    • Create a consent
    • Retrieve consent details
    • Revoke a consent
  • AUTHENTICATION

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

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

    • Introduction
    • View accounts
    • View balance
    • View transactions
    • Identify account holders (Parties)
    • Review direct debits
    • Review scheduled payments
    • Review standing orders
  • Payment APIs

  • DATA USE CASE APIS

  • SADAD

  • Plug-and-Play Integrations

    • Payly
  • RESOURCES

    • POR Details
    • Error codes
    • Errors & codes
    • Collections
    • API version management
    • Bank connectivity
  • API Archives


Integration guide

Follow a step-by-step path to integrate with the SingleView B2B API Suite

This guide provides an overview of the integration journey for the SingleView B2B Core APIs. It outlines the key steps required to access the platform, configure security, test your implementation, and prepare your application for production use.

Whether you are integrating Data APIs, Payment APIs, or both, following the recommended integration process will help ensure a secure and successful deployment.

Integration Journey

Step 1: Register an Account

Begin by creating a developer account to access the SingleView platform.

Account registration provides access to the developer portal, API documentation, environment details, and integration resources required to get started.

What you'll do:

  • Create a developer account
  • Verify your contact information
  • Complete onboarding requirements
  • Access the SingleView Console
Outcome

You can access the developer portal and begin preparing your application for integration.

Step 2: Prerequisites for Sandbox

Before connecting to the sandbox environment, ensure that your application and development environment meet the required prerequisites.

The sandbox environment allows you to test API functionality, validate request flows, and familiarize yourself with platform behavior before moving to production.

Things you'll need:

  • An active developer account
  • Access to the sandbox environment
  • Application credentials
  • Network connectivity to the sandbox endpoints
  • Development tools for API testing (such as Postman or equivalent)

Recommended Preparation

  • Review API documentation
  • Understand authentication requirements
  • Familiarize yourself with available test scenarios
  • Review sample requests and responses
Outcome

Your development environment is ready for sandbox testing.

Step 3: Establish a Secure Connection

All communication with the SingleView platform must occur through secure channels.

The platform uses industry-standard security protocols to protect data exchanged between client applications and API services.

What you'll do:

  • Configure HTTPS communication
  • Obtain environment endpoints
  • Verify network connectivity
  • Validate communication with the sandbox environment
Outcome

Your application can securely communicate with SingleView API services.

Step 4: Authenticate Your Requests

Before accessing API services, your application must successfully authenticate and authorize API requests.

SingleView uses a layered security model that combines access tokens and request signatures to verify the identity of calling applications and ensure message integrity.

  • Access Token: Access tokens are used to authenticate your application and authorize access to platform resources.
  • Request Signature: Request signatures provide an additional security layer by validating that requests have not been modified during transmission.

What you'll do

  • Generate an access token
  • Configure authorization headers
  • Generate request signatures
Outcome

Your application can securely access protected API endpoints.

Step 5: Make Your First Test API Call

Once authentication has been configured, you can begin interacting with the available API services.

The recommended approach is to start with a simple API request to validate connectivity, authentication, and response handling.

Typical Validation Activities

  • Submit an authenticated API request
  • Validate the API response
  • Review error handling behavior
  • Confirm successful end-to-end communication
Outcome

You have successfully connected to the platform and completed your first API interaction.

Step 6: Prerequisites for Production

Before migrating your application to the production environment, ensure that all operational, security, and compliance requirements have been satisfied.

Production access is intended for live business transactions and requires additional readiness validation.

Requirements

  • Successful sandbox testing completed
  • Authentication implementation validated
  • Error handling implemented
  • Security controls reviewed
  • Application testing completed
  • Operational support processes established
  • Obtain production credentials
  • Configure production endpoints
  • Update application configuration
  • Perform production connectivity validation
Outcome

Your application is prepared for production onboarding and deployment.

Step 7: Move to Production

After completing testing and meeting all production readiness requirements, you can transition your integration to the production environment.

This process enables your application to access live services and process real business transactions.

What you'll do:

  • Begin processing live requests
Outcome

Your application is successfully integrated with the SingleView B2B API Suite and ready to operate in a live environment.

 

For detailed implementation instructions, refer to the Authentication, API Reference, and Service-Specific Guides sections of the documentation.

Updated July 10, 2026

Was this helpful?