Are you looking to take your business to the next level? Our Merchant API serves a wide range of use cases that can streamline your e-commerce operations and improve your bottom line. The Cyrexa Merchant account is a sub-account of your Cyrexa Business account. While a business account is for managing your business finances, the Merchant account is dedicated to helping you accept online payments from your e-commerce customers.


Get Started	Get Started Sign up for a Cyrexa Merchant account and get up and running in few steps.
Customers	The Customers resource in the Merchant API is a pivotal tool for tracking and managing customer-related transactions within your e-commerce or retail platform
Payment methods	As payment convenience is key to a seamless customer experience, we strive to make payments as effortless and secure as possible. Choose the payment method that suits your needs.
Open Banking	Open Banking is the gateway for third-party providers to interact with Cyrexa customers and products.

Get Started

To start using the services provided by Cyrexa, you need to perform an integration first. The first integration is performed within a sandbox environment, allowing you to test the tools offered by Cyrexa. Once all the tests are finished, a live account for real payments and other financial operations is prepared. After you switch to the live account, your system becomes ready to accept live payments. The sections below contain the steps that you need to perform to integrate with Cyrexa. Sandbox Integration

Your website representative will provide us with contact details for your technical specialist (this should include their name, email, and optional contact data such as mobile number or Skype ID).
We will then send the email with login credentials (login and link) and instructions for the first entering to the Sandbox Merchant Account to your designated technical specialist.
Your technical specialist needs to follow the instructions and set a permanent password to the Sandbox Merchant Account.
The API integration parameters are available in the Sandbox Merchant Account. Please check integration status with your Account manager.
Your technical specialist will need to use terminal ID, terminal password, callback secret which will be provided in the Sandbox Merchant Account.

Live Integration To be filled Later

Customers

The Customers resource in the Merchant API is a pivotal tool for tracking and managing customer-related transactions within your e-commerce or retail platform. This resource provides a structured approach to customer management, enabling you to maintain a consistent record of customer transactions. A Customer object can be created using the Create a customer endpoint and you can then retrieve, update, and delete a customer using its id. Customer objects enable you to track multiple transactions in your system associated with the same customer in the Merchant API. A merchant can store the details of the payment securely and group transactions from the same payment method in their system. A payment method is unique for each customer. For example, if the same card is used for a transaction by two different customers, two payment method objects are created linked to each customer.


Create Customer	This helps merchant to create customers for both B2B and B2C.
Update Customer	This helps merchant to update customer details for both B2B and B2C
Fetch Customer List based on Tenant ID This help merchant to seek list of customers under the tenant.	This help merchant to seek list of customers under the tenant.
Fetch Customer List based on Organization ID This help merchant to seek list of customers under the organization.	This help merchant to seek list of customers under the organization.
Fetch Customer Details based on Customer ID	This help merchant to seek customer details based on the customer ID

Online Card Payment

Introduction to online card payments As a Cyrexa Business customer with an active Merchant account, you have several ways to accept card payments through your e-commerce website. As card payments are one of the most adopted standards in today’s digital commerce, it is crucial for merchants to offer a convenient payment option for customers. For customers, card payments mean quicker and secure checkouts, while for merchants, this translates into faster transaction processing and often increase in sales. Why offer online card payment solutions? Card payments bring several advantages to merchants, enhancing both operational efficiency and customer engagement. Here are some key benefits:

Improved customer experience: Providing a card payment option often results in a quicker and more convenient checkout process for customers. This efficiency can enhance customer satisfaction and contribute to building customer loyalty and repeat business.
Increased sales opportunities: Accepting card payments can potentially increase sales as it enables merchants to cater to customers who prefer or require credit facilities or wish to make larger purchases that might not be feasible with limited immediate funds.
Enhanced security: Modern card payment systems are equipped with advanced security features like encryption and tokenization, significantly reducing the risk of fraud and data breaches. This security is vital in protecting both merchant and customer data.
Global reach: Card payments enable merchants to easily accept payments from customers all over the world, expanding their market reach far beyond local boundaries. This is particularly beneficial for online businesses looking to tap into global markets.
Access to financial insights: Card payments generate valuable data that can be analysed for insights into consumer behaviour, sales trends, and business performance. This information can be leveraged to make informed business decisions and strategies.
Streamlined transaction processing: Card payments can be smoothly integrated with digital commercial and accounting systems, leading to efficient and accurate transaction management. This integration facilitates easier accounting and financial reporting.

Generate Bearer TokenFor generating Bearer Token, please provide the following information in the Generate Bearer Token

clientId: H2DvULzTrPe0ScVSu9kENieW7dga
clientSecret: TxPBH2KkwEETcpjkFG_u0o57BpIa

Once the bearer token is generated, it will be active for 10,000 seconds (approx. 2.7 hours).

Wallet Top-up Via Card


Initiate the Top-up Transaction (Saved Card/One-Time Use)	Begin the wallet top-up process using either a saved card or a one-time payment card
3DS Authorization	Perform 3D Secure (3DS) authentication to ensure the security of the transaction
Capture the Transaction	Secure and reserve (Capture Success, Failed…) the transaction amount from the customer’s card.
Settle the Transaction	Finalize the payment, moving the reserved funds from the customer’s card to the wallet
Refund/Cancel the Transaction	Reverse a completed or ongoing transaction
View/Export Transaction/Order History	Access and download the history of transactions and orders for record-keeping or review.
Manage Saved Card	Add, update, or delete cards saved for future transactions
Manage Fee	Set and adjust any fees associated with wallet top-ups or related transactions.
Manage Limit	View, define or modify transaction limits, such as daily or per-transaction caps

Payment Link Management


Add Inventory	Enter new inventory items that can be associated with payment links or transactions.
Approve/Reject Inventory (Tenant)	Review and approve or reject inventory items submitted by Seller before they go live.
Manage (View, List) Inventory	Oversee inventory, including viewing, listing, and making adjustments as needed.
Create Payment Link (Order)	Generate a payment link specifically tied to an order or transaction
Approve/Reject Payment Link (Tenant - Optional)	Allow tenants to approve or reject payment links before they are finalized.
Manage (View, List, Disable/Enable)	Pay Link Control and maintain payment links, including activation, deactivation, and status updates.
Share the Link (SMS, Email, External)	Distribute the generated payment link to customers or clients through various channels.
Access the Link – Payment Options	Enable buyers to access the payment link and choose from available payment options
Access the Link – Ticket Support	Enable buyers to access the payment link and seek support via a ticket
Access the Link – Order Status/History	Enable buyers to access the payment link and track the payment order status for paid orders

Payment Link – Cards


Initiate the Top-up Transaction - Buyer	Allow buyers to begin a onetime payment process using a provided payment link using a card. (Coming Soon)
3DS Authorization	Perform 3D Secure (3DS) authentication to ensure the security of the transaction (Coming Soon)
Capture the Transaction	Secure and reserve (Capture Success, Failed the transaction amount from the customer’s card. (Coming Soon)
Settle the Transaction	Finalize the payment, moving the reserved funds from the customer’s card to the Tenant wallet. (Coming Soon)
Clear the Transaction – FinCore Order – Tenant to Seller	Finalize and clear the payment, transferring the funds from the tenant to the seller. (Coming Soon)
Refund/Cancel the Transaction:	Reverse a completed or ongoing transaction. (Coming Soon)
View/Export Transaction/Order History	Access and download the history of transactions and orders for record-keeping or review. (Coming Soon)
Manage Fee	Adjust or set fees related to transactions made through payment links. (Coming Soon)
Manage Limit	Define or adjust transaction limits for buyer-initiated payments. (Coming Soon)

Pay Link Payment – External/Internal Bank


Share Bank Detail on the Payment Link– Seller	Share the seller’s bank details with the buyer for bank transfer payments. (Coming Soon)
Receive the Transaction – Settlement	Accept payments into the bank account for final settlement (Coming Soon)
Clear the Transaction – FinCore Order (To be confirmed)	Confirm and finalize the settlement of payments. (Coming Soon)
Reverse Transaction	Reverse a payment or transaction, returning the funds to the payer. (Coming Soon)
View/Export Transaction/Order History	Review and export transaction history related to bank payments (Coming Soon)
Manage Fee	Set and manage any fees associated with bank payments (Coming Soon)
Manage Limit	Define or update transaction limits for bank-based payments (Coming Soon)

Pay Link Payment – Internal P2P Payment


Manage Customer	Add, update, and manage customer profiles for P2P transactions.
Send the Payment	Initiate and send payments between customers within the platform.
Receive the Payment – Settlement	Accept and settle payments received from another customer.
Reverse Transaction	Process reversals of P2P payments, returning funds to the original sender
View/Export Transaction/Order History	Access and download the history of P2P transactions for review or record-keeping
Manage Fee	Set and adjust fees related to internal P2P transactions.
Manage Limit	Define and modify limits for internal P2P transactions

Open Banking

The Cyrexa Open Banking API is the gateway for third-party providers to interact with Cyrexa customers and products. Clients can use the Open Banking API to develop banking applications, whether they are: A regulated third-party provider that wants to get account and transaction information of Cyrexa customers and initiate different types of payments, or An innovative service provider that is looking to seamlessly integrate Cyrexa functions into your own applications. The Open Banking API can be tested in Postman:

Authentication

Get Access token Certificates The following certificates must be used to request an access token.

transport.pem: The transport certificate is converted to *.pem format in the Convert certificates
server.key: The server certificate is generated in step Generate CSR certificate

Headers

Content-Type: application/x-www-form-urlencoded #Parameters grant_type: Must be set to client_credentials to get the access token. scope: Must be set to accounts.

Example

When using a self-signed certificate or a certificate not known by standard Certificate authorities, the -k or —insecure cURL option should be used.

curl -k --cert transport.pem --key server.key \
--location -X POST 'https://oba-auth.cyrexa.com/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials' \
-d 'scope=accounts' \

curl -k --cert transport.pem --key server.key \
--location -X POST 'https://oba-auth.cyrexa.codes/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials' \
-d 'scope=accounts' \

Response

The response contains the following JSON object:

{
  'access_token':'<access token>',
  'token_type':'Bearer',
  'expires_in':2399
}

What’s Next This access token serves to authenticate the bearer for all subsequent requests to the API. It can be refreshed before it expires.

Authorisation

Each Open Banking API must contain an authorisation header in the following format to make a call: Bearer ‘yourAccessToken’ Before starting, users must ensure they have an access token with the proper scope using the /token endpoint. An authorisation code must be obtained so it can be exchanged for an access token. x-jws-signature Open Banking API Payment requests additionally require a JSON Web Signature (JWS). The signature needs to be added to the header of the request. The JWS must be obtained using the full content of the payload.

Accounts


Create an account access consent	Before you can access any data, you must create an access consent to read data from the user’s profile.
Retrieve an account access consent	Get the details of the account access consent
Delete an account access consent	Reject a consent if it is in the Awaiting Authorisation state or any error occurs while the consent is being authorised. Revoke a consent if it is in the Authorised state.
Retrieve all accounts	Get a list of user accounts.
Retrieve an account	Get the information about a specific account by ID.
Retrieve an account balance	Get the balance of an account.
Retrieve all account’s beneficiaries	Get all the beneficiaries of a specific user account.

Transactions


Retrieve all account’s direct debits	Get a list of all the direct debits for a specific user account.
Retrieve all account’s standing orders	Get a list of all the standing orders for a specific user account.
Retrieve all transactions	Get all the recent transactions for an account.

Merchant API

A set of merchant integration APIs

Home

Token

Merchant API

Customer

Open Banking API

​Get Started

​Customers

​Online Card Payment

​Wallet Top-up Via Card

​Payment Link Management

​Payment Link – Cards

​Pay Link Payment – External/Internal Bank

​Pay Link Payment – Internal P2P Payment

​Open Banking

​Authentication

​Headers

​Example

​Response

​Authorisation

​Accounts

​Transactions

Merchant API

Get Started

Customers

Online Card Payment

Wallet Top-up Via Card

Payment Link Management

Payment Link – Cards

Pay Link Payment – External/Internal Bank

Pay Link Payment – Internal P2P Payment

Open Banking

Authentication

Headers

Example

Response

Authorisation

Accounts

Transactions