Documentation
Start typing to search…

On Ledger Account Management

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.

Using the CLOWD9 Account Management APIs, you will be able to:

Create Account

Using the account_profile_id provided during the Implementation Project, you will be able to create the Account(s) required for your Customers.

The default status on an Account is inactive; however using the account_status field, you can override this to be active immediately. The Account can be changed at any stage using the Set Account Status API.

The Account must be linked to the customer_id in addition to the card_id where the Customer will be using their payment device (Virtual and / or physical cards, tokenized devices etc).

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

Account Status

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 be set to active when the Account is created or at a later date. Once active, activity will be permitted
  • freeze: A temporary block to restrict all activity on the Account pending the outcome of any investigation. Post investigations the Account should be changed to the required status
  • closed: In the event of a Customer request or an Account is no longer required, the Account should be set to closed which is a non reversible status. Remaining balances should be removed prior to the close status being applied

Customer to Account Link

You can link the Customer and Account when the Account is created where the Customer record has already been created.

If not and the Account(s) is created in advance, using the Customer to Account Link API will complete the link.

Removing the Customer to Account Link

There may be reasons that the Account is to be removed from the Customer which can be achieved using the Remove the Customer to Account Link API.

Card to Account Link

The On Ledger solution supports standalone Accounts in addition to those that can be linked to one or multiple payment devices.

Before your Customer can successfully use their Payment device(s), the Card to Account Link API must be completed.

Removing the Card to Account Link

In the event the card_id and account_id have been incorrectly linked, or for any reason the linkage is to be removed, the Remove the Card to Account Link is to be used.

Increase Account Balance

To reflect the Customer balance held on your platform, the Increase Account Balance API will used. As this is a Financial Ledger Entry, the amount must be greater than 0, otherwise the request will be rejected.

A unique reference_id must be provided for every request for reporting purposes as well to mitigate the risk of the same request been submitted and processed more than once.

Whilst not mandatory, the following can be provided:

  • reference_name: This could be the type of transfer (Debit Card, Bank Transfer), or could be a fee being applied
  • reference: You may offer your Customers to add a reference for the request

Decrease Account Balance

Where your Customer requests the balance to be reduced or as part an Account closure activity, the Decrease Account Balance API is used.

Similar to the Increase Account Balance, a unique reference_id must be provided for every request for reporting purposes as well to mitigate the risk of the same request been submitted and processed more than once.

Whilst not mandatory, the following can be provided:

  • reference_name: This could be the type of transfer (Debit Card, Bank Transfer), or could be a fee being applied
  • reference: You may offer your Customers to add a reference for the request

You will not be able to decrease the balance lower than the Available Balance amount.

Account to Account Transfer

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.

A unique reference_id must be provided for every request for reporting purposes as well to mitigate the risk of the same request been submitted and processed more than once.

Retrieve Account Information

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

Updated about 2 hours ago