ByQwest Api Documentation

Log in to access to the documentation

Forgot your password ?

Enter your email address to receive your reset code.

Reset your password

Enter the code you received and your new password to get it reset and do not share it to anyone !

Reset your password

Enter your new password to get it reset and do not share it to anyone !

Welcome !

Please choose a password to complete your registration.

Password should be at least 8 charactersThe more characters, the better

Password should have both uppercase and lowercase letters

Password should have mixture of letters and numbers

Password should include at least one special character, e.g., ! @ # ? ]

Welcome !

Please choose a password to complete your registration.

Password should be at least 8 charactersThe more characters, the better

Password should have both uppercase and lowercase letters

Password should have mixture of letters and numbers

Password should include at least one special character, e.g., ! @ # ? ]

Wait ! Security first...

Authentification code

Multi-Factor Authentication
Please scan the QR code with your device to get your authentification code.
This is the only QR code we will give you if you exit now all the previous token will be deleted.
Authentification code
Enter the verification code from your device to activate the 2FA
menu

Admin

menu

GENERAL BEHAVIOR

  • overview

    Architecture

  • overview

    Common behavior

  • overview

    Security

  • overview

    Batch

BANKQWEST

  • overview

    Introduction

  • overview

    AdmAPI

  • overview

    ConsumerAPI

  • overview

    UserAPI

  • overview

    Webhooks

CLEARQWEST

  • overview

    Introduction

  • overview

    AdmAPI

  • overview

    ConsumerAPI

  • overview

    Webhooks

LEDGERQWEST

  • overview

    Introduction

  • overview

    Transaction

  • overview

    Limits

  • overview

    Clearing

  • overview

    AdmAPI

  • overview

    ConsumerAPI

  • overview

    Webhooks

CMSQWEST

  • overview

    Introduction

  • overview

    AdmAPI

  • overview

    ConsumerAPI

  • overview

    Webhooks

CARDQWEST

  • overview

    Introduction

  • overview

    AdmAPI

  • overview

    ConsumerAPI

  • overview

    Webhooks

arrow deepblueRetour

Role
Password

Never tell your password to anybody. It's your secret !

ByQwest provides a serie "micro-processors" (aka "processor" when instantiated in a platform in the APIs) that can work together to offer any complex payment products (aka a platform).

A platform can be instanciated with any number of these processors. In addition, the same micro-processor can be instanciated several times (for geographic reason, for data reason, etc) /p>

These micro-processors (in black in the platform graph below) are :

  • BankQwest: a micro-processor managing the banking objects such as IBANs, mandates, legal and natural persons. In addition, it provides a user and user-interface management and a datalake functionnality
  • ClearQwest: a micro-processor managing the banking payment rails such as SEPA in a FI to FI mode
  • LedgerQwest: a multi-currency, multi-custodian ledger management with multi-curency limit and auto-clearing
  • CMSQwest: a Card Management System with dynamic authorization routing and deep trade management
  • CardQwest: a certified issuing/processing platform managing all types of cards and tokens

The processors share a common behavior based on the same API security and common objects in each.

AdmAPI

A set of APIs used to administrate the processor in the platform. Used by ByQwest or a BAAS administrator role

Each processor provides a set af AdmAPI. These APIs are used for processor configuration. A part of this configuration is license management. Each processor have objects managing the licenses. It allows the conumer to create product using different licenses at the same time. It also permits to keep a license view on the objects with the admAPI the AdmAPI.

ConsumerAPI

A set of APIs that allows the usage of the processor. Used by a Bank or an Agent for example

API security

The security of the external APIs is twofold. A mtls layer and a specific b2b JWT described int the security part. In any case, the consumer must keep its private keys private.

Identify an object

Each object is identified uniquely with an object uuid. This uuid is unique per construction and can be share between the processors. When a object of a processr is linked is referenced in an other processor, the object uuid if often stored with its processor_uuid owner

Common Objects

  • processor: Reference a processor which is an intance of a micro-processor for a platform. It's a real instance running somewhere. A platform running can have several processors of the same type
  • application: A set of APIs like AdmApi or consumerApi, or an other application.
  • consumer: API user that can use AmdAPI or ConsumerApi. A consumer able to use admAPI must be admin. A consumer can exist in several processor, tt will wil the same uuid.
  • access: An access for a consumer to use an application on a processor. A consumer must bue authorized by an admapi call to create an access on an application. Accesses can be created by admapi or consumeapi. A consumer can create has many accesses as wantd. A good behavior is to create an access for each different function calling the APIs and change the private keys reguraly. It can be a delegated access used automatically by a consumer when his activity in a processor provokes calls in other processors
  • webhook: A configuration that authorize the activity of a consumer to provoke callbaks. The webhook can be calling other processors or external callback endpoints
  • udf: A User Defined Function. In a processor, some process can be configured with an UDF. It allocs the configuration to execte specific code for a specific product
  • *product: Products are not common objects but processor specific objects that exist in every processor.

BankQwest is the main interface if the client needs to pilot its end customers with the platform. It provides also the management of Banking address (for example IBANs).

AdmAPI users can create Institution. These objects allows a consumer to create product managing bank addresses (address).

The administrator can also create Interfaces that will permit the user and role management linked to AWS cognito in the user interfaces such as websites and mobile application.

The consumer can create and manage its own persons as natural or legal persons and linke them together or to the objects of other processor such as accounts, addresses or cards.

Main Features

Person management: Control the the ownership of the platform objects.

IBAN issuing: Issue you IBANs with your own rules.

End user security: Control your interfaces and your roles.

Datalake: Study your data on the datalake.

UserAPI: A set of API allows the connection of end users based of OAuth2 AWS Cognito service.

Data model

Our versatile payment messaging system that Clears transactions via industry-standard payment rails such as SWIFT, SEPA, or SEPA Direct Debit (SDD).

Plug and Play SEPA as a Financial Institution

Tested on all exception flows

Main Features

Credit Transfer: Manage outgoing and incoming credit transfers.

Direct Debit: Manage outgoing and incoming direct debit.

Credit transfer data model

Direct Debit data model

LedgerQwest is ByQwest's robust core banking system. This micro-processor is bale to manage all types of accounting Ledgers in any one or more currencies including virtual accounts, settlement, custodians, etc.

Main features

Transaction accounting: Provide a real-time accounting based on transaction managament.

Multi-custodians: Manage you accounts in any number of custodians. Allow real-time transfers between account havig their physical money in different banks

Multi-currency: Manage your accounts in different currencies. Allow real-time fx transfer between accounts.

Multi-currency and multi-accounts limits: Create limit on any number of accounts even in different currencies.

partial-authorizations: Manage authorizations and partial authorizations. Increase, decrease, cancel or clear them.

fee collection: Collect the fees in real-time.

Automatic clearing: Configure automatic clearing between the custodians depeding of the tranaction_type.

Data model

A transaction is the only way to move money from or to an account. An authorization blocks the money on an acount.

A transaction can between 2 custiodians and in 2 currencies.

A transaction never loose money. The money taken from an account is put in an other account.

A transaction is either totally successful or totally rollbacked. It can't be partially executed.

The main parameters of a transaction can't be modified (only the details can be modified)

To revert a transaction a reimbursement must be done. It will create automatically the reverse transsaction by creating a new transaction.

A transaction can impact any number of limits on the accounts. It will create consumptions on thses limits.

Transactions levels

LeadgerQwest allows an efficient clearing configuration.

The clearing can be configured at the custodian level to process automatically the clearing when the following transactions occur.

transaction/clearing

transaction/incoming

transaction/outcoming

transaction/fx

transaction/transfer (when the custians of the 2 accounts are not the same.

Clearing configuration example

CmsQwest is our flexible Card Management System to configure and operationally manage all types of cards such as prepaid, debit or credit; and card configurations like single or multi-currency, limits, and geography, to name a few.

Main features

Dynamic authorization routes: Define your own authorization routes to your balances

Trade management: Trades provide an aggregate view of all the messages for a purchase.

Card limits: Manage complex use case by with your card limits

Service filtering: Filter the services at card level

CardQwest is a sophisticated Card issuing and processing engine. It's VISA certified all products and it's PCI-DSS 4.0 level 1 service provider compliant.

Main features

Virtual card: Issue Virtual card instantly.

3DS: Manage your your 3DS configuration

Physical card: Issue physical card with complex configuration. For example, close loop and open loop dual cards.

Multiple Card Service Bureaus: Manage multiple card servce bureaus

Tokenization: Open tokenization on your BINs. Manage your Token Activation Requests risk process.

Push Provisionning: Generate the secure elements for Apple Pay and Google Pay push provisionning.