Subledgers allow you to segregate balances by funds flow or for each of your customers. There are two types of subledgers you can create:

  1. Subledgers associated with your enterprise
  2. Subledgers associated with any verified person or business

When initiating a transfer associated with a subledger, you simply include the subledger_reference_id in the transfer request. Orum will automatically debit or credit the appropriate subledger balance.

Funds allocated to a subledger are reserved exclusively for that subledger’s use. To fund a subledger associated with a verified person or business, initiate a from your enterprise balance. You can also transfer to your enterprise account from a subledger in the same way — via a book transfer. 

​
Creating Subledgers

A subledger must be associated with your enterprise or with a verified person or business.

Endpoints

  • POST /deliver/subledgers - create a subledger
  • GET /deliver/subledgers/id - fetch single subledger by id
  • GET /deliver/subledgers - fetch all subledgers

An unlimited number of persons, businesses, or enterprises can interact with a subledger.

Example

{
  "subledger_reference_id": "string",
  "customer_reference_id": "string",
}

​
Initiating Book Transfers

Book transfers happen instantly and enable you to fund a subledger or move funds from the subledger back to your enterprise balance.

Endpoints

  • POST /deliver/booktransfers - create a book transfer
  • GET /deliver/booktransfers/id - fetch single book transfer by id
  • GET /deliver/booktransfers - fetch all book transfers

Book transfers cannot be cancelled.

Example

{
  "booktransfer_reference_id": "string",
  "amount": 0,
  "source": {
    "subledger_reference_id": "string",
   }
}

​
Intiating Subledger Transfers

To initiate a subledger as part of a transfer, utilize the optional subledger_reference id field in the transfers request body.

Depending on your use case, you may be required to populate the subledger_reference id with every transfer.

If you’re initiating a dual leg transfer with a subledger, one of the parties in the transfer must be associated with the subledger or be a subledger associated with your enterprise.

If the subledger is associated with your enterprise, then the flow of funds works in the same way as it does when you make transfers from your enterprise balance. However, if the subledger is associated with a person or business, you’ll need to be configured for dual leg flow of funds.

Unsure if you need dual leg configuration? Send a note to [email protected] and we’ll let you know based on your use case.

Example

"transfer_reference_id": "<string>",
  "amount": 2,
  "currency": "USD",
  "speed": "asap",
  "source": {
    "customer_reference_id": "<string>",
    "account_reference_id": "<string>",
    "statement_display_name": "<string>"
  },
  "destination": {
    "customer_reference_id": "<string>",
    "account_reference_id": "<string>",
    "statement_display_name": "<string>"
  },
  "account_statement_descriptor": "<string>",
  "metadata": {},
  "subledger_reference_id": "AcmeCo"
}'

​
Checking Balances

There are three types of balances on the Orum platform, each of which includes a pending and available balance. All balances can be accessed via API or Monitor:

  • Enterprise Balance: Your primary operational balance. This does not include the funds that have been allocated to subledgers.
  • Subledger Balance: The balance associated with a subledger.
  • Total Balance: The combined balance across your enterprise and all subledgers.