- Subledgers associated with your enterprise
- Subledgers associated with any verified
person
orbusiness
subledger_reference_id
in the transfer request and we’ll 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 verifiedperson
or business
.
Endpoints
- POST /deliver/subledgers: Create a subledger
- GET /deliver/subledgers: Get all subledgers
- GET /deliver/subledgers/id: Get a subledger by id
An unlimited number of persons, businesses, or enterprises can interact with a subledger.
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: Get all book transfers
- GET /deliver/booktransfers/id: Get a book transfer by id
Book transfers cannot be cancelled.
Intiating Subledger Transfers
To initiate a transfer to a subledger, use thesubledger_reference id
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.
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.
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.