Get Started

Introduction

BIEASES payment API is a service provided to merchants who can integrate BIEASES as a new payment method on their e-commerce platform or other order systems. BIEASES payment API can be integrated easily with just one API.

How does the BIEASES payment API work?

Check the diagram below to find out how the BIEASES payment API works with End User/Merchant and BIEASES.

Integration Steps

Please follow the steps below to complete the BIEASES payment API integration flow.

1. Follow the Quick Start guide to Sign Up and complete the KYB.
2. Request sandbox access to create a sandbox and get sandbox secure keys.
3. The merchant completes the development and testing in the sandbox environment.
4. Once the development and testing are complete, contact [email protected] or your account manager to request production secure keys.
5. Go live.

Setup Environment

Generate keys

BIEASES will generate and provide the signing/encryption keys. Please contact your account manager or [email protected] to get your keys generated once you have completed the onboarding process.

🚧

Note:

Keep the private key secure, and do not share it with anyone else.

Sandbox

📘

Prerequisites:

• Have a valid BIEASES merchant account (follow the Quick Start to create a merchant account).

Request sandbox access

Merchants use the BIEASES payment API sandbox to develop and test their integration with BIEASES.

Only merchant users can access the sandbox environment. Please send a request to [email protected] with your merchant ID to obtain sandbox environment access and the secure keys.

The secure keys include:

Key Type	Description
RSA key pairs	Used to sign and verify the signature. Includes the public key and private key.
AES key	Used to encrypt/decrypt the payment order information.
IV string	A unique, random, and non-repeating value used in cryptography to add randomization to the encryption process.

Each key is bound to the merchant ID.

🚧

Note:

Currently, the sandbox can only be accessed via a website. Mobile apps are not supported.

Endpoints and Login Portal

For the EEA/UK Region:

• API Endpoint:
  • EEA Sandbox API base URL: https://app-sandbox-eea.bieases.com
  • UK Sandbox API base URL: https://app-sandbox-uk.bieases.com
• Login Portal:
  • For merchant user: https://merchant-sandbox.bieases.com
  • For individual user: https://app-sandbox.bieases.com

Production

📘

Prerequisites:

• Have completed the development and testing in a sandbox environment.

Request production secure keys

Once the merchant has completed the development and testing in the sandbox, contact [email protected] to issue the production secure keys.

The secure keys include:

Key Type	Description
RSA key pairs	Used to sign and verify the signature. Includes the public key and private key.
AES key	Used to encrypt/decrypt the payment order information.
IV string	A unique, random, and non-repeating value used in cryptography to add randomization to the encryption process.

🚧

Note:

1. Please keep the production secure keys safe and do not share those keys with anyone else.
2. Please contact [email protected] to re-issue the keys if a key was lost.

Production Endpoint(s)

Replace the sandbox base URL with the production URL while deploying to the merchant production environment.

For the EEA/UK Region:

• API Endpoint:
  • EEA Region:
    • Production API base URL: https://app-eea.bieases.com
  • UK Region:
    • Production API base URL: https://app-uk.bieases.com
• Login Portal:
  • For merchant user: https://merchant.bieases.com
  • For individual user: https://app.bieases.com

📘

Note:

All HTTP requests require TLS 1.2 or higher.

Whitelist server IP address

Before going live, the merchant back-end server IP address(es) need to be whitelisted. Please contact [email protected] to add your back-end server IP address to the whitelist or update the IP whitelist.