Skip to main content
POST
/
deliver
/
subledgers
Create a subledger
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/subledgers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "subledger_reference_id": "<string>",
  "customer_reference_id": "<string>"
}
'
{
  "subledger": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subledger_reference_id": "<string>",
    "customer_reference_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.orum.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
subledger_reference_id
string
required

Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255
​
customer_reference_id
string
required

Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

Response

200 response.

​
subledger
object
required