On Ledger APIs

The CLOWD9 On Ledger solution enables your Customers to spend against their Available Balance as per the agreed Terms and Conditions where CLOWD9 platforms act as the system of financial/asset record.

The following APIs will enable you to create and manage the Accounts:

Before your Customers can use their payment devices (Virtual and / or physical cards, tokenized devices etc), the Account will need to be created.

The type of Account(s) created via this API will as per your Product configuration. For example:

  • Product supports a single GBP currency Account, CLOWD9 will create and provide the account_id for the GBP Account
  • Product supports multi-currency, CLOWD9 will generated the configured number of Accounts and their associated currencies

The following Account Status types are applicable:

  • inactive: Default value which is applied by CLOWD9. Once the Account status has been changed from inactive, this can never be reverted to this status. All activity is restricted under this status and restricts all activity to the Account such as:
    • Balance updates
    • Use of any card_id and or dpan_ids that the Customer may have i.e. authorizations will be decline
  • active: The Account can set to active during the Create Account or at a later date. All activity will be permitted
  • administrative: A temporary block to restrict all activity on the Account pending the outcome of any investigation. Post investigations the Account should be returned to active, fraud or closed
    fraud: A permanent status which is to be used where the Account and / or associated payment devices have had fraudulent activity. A new Account will need to be created
  • closed: In the event of the Customer requiring to close their Account, once remaining funds have been removed from the Account balance and all relevant actions completed in line with your procedures, the Account should be set to closed

The On Ledger solution supports standalone Accounts as well as Accounts that can be linked to one or multiple payment devices.

When the Account is created, it is standalone. This API is used to link the card_id to the Account.

For single currency products, if the card_id is already linked to an Account, this will be replaced by the new account_id.


Enables your Customers to transfer funds from one Account to another. This could be from their main Account to a savings Account, to a Child Account.

Optional reference and reference identifier can be provided for reconciliation and reporting purposes.


The Update Account Balance enables you and your Customers to Credit or Debit an Account as required. For example:

  • Funds loaded by external source such as Debit / Credit, Bank Transfer
  • Funds removed following closure or other reasons

You will be able to retrieve the information held for a specific account_id. CLOWD9 will provide the information held for the Account as follows:

  • account_id: The Identifier of the Account Profile the Account is associated with
  • account_currency: The currency of the account
  • account_type:The type of Account. Single or Multi
  • behaviour_id: The Identifier of the Behaviour (Limits, Fees, Usage, etc) associated with the Account
  • account_balance:The total balance of the account, this is not the amount that can be spent
  • account_balance_direction:Identifies if the Account is in a positive (Credit) or negative (Debit) position
  • available_account_balance:The value amount that is available to be used
  • available_account_balance_direction:Identifies if the available balance is in a positive (Credit) or negative (Debit) position
  • pending_authorized_amount:The total amount of authorized spend if via the Network