Central Ledger API Documentation

Base URL: /, Version: 3.8.3

Schemes: http

Summary

Tag: enums

Operation Description
GET /enums

Tag: health

Operation Description
GET /health

Tag: participants

Operation Description
GET /participants
POST /participants
GET /participants/{name}
PUT /participants/{name}
GET /participants/{name}/endpoints

View participant endpoints

POST /participants/{name}/endpoints

Add/Update participant endpoints

GET /participants/{name}/limits

View participant limits

POST /participants/{name}/limits

Adjust participant limits

GET /participants/{name}/positions

View participant positions

GET /participants/{name}/accounts

View participant accounts balances

POST /participants/{name}/accounts

Create hub accounts

POST /participants/{name}/initialPositionAndLimits

Add initial participant limits and position

POST /participants/{name}/accounts/{id}

Record Funds In or Out of participant account

PUT /participants/{name}/accounts/{id}/transfers/{transferId}

Record Funds In or Out of participant account

Tag:

Operation Description
GET /

Paths

GET /

Tags:
default

Successful

GET /enums

Tags: enums
default

Successful

GET /health

Tags: health
default

Successful

GET /participants

Tags: participants
default

Successful

POST /participants

Tags: participants
default

Successful

GET /participants/{name}

Tags: participants
Name Description Type Data Type Annotation
name

Participant name

path string
default

Successful

PUT /participants/{name}

Tags: participants
Name Description Type Data Type Annotation
name

Participant name

path string
default

Successful

View participant accounts balances

GET /participants/{name}/accounts

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
default

Successful

Create hub accounts

POST /participants/{name}/accounts

Tags: participants
Name Description Type Data Type Annotation
name

Participant name

path string
default

Successful

Record Funds In or Out of participant account

POST /participants/{name}/accounts/{id}

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
id path integer
default

Successful

Record Funds In or Out of participant account

PUT /participants/{name}/accounts/{id}/transfers/{transferId}

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
id path integer
transferId path string
default

Successful

View participant endpoints

GET /participants/{name}/endpoints

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
default

Successful

Add/Update participant endpoints

POST /participants/{name}/endpoints

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
default

Successful

Add initial participant limits and position

POST /participants/{name}/initialPositionAndLimits

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
default

Successful

View participant limits

GET /participants/{name}/limits

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
currency

Currency code of the participant

query string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }
type

Limit Type

query string
default

Successful

Adjust participant limits

POST /participants/{name}/limits

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
default

Successful

View participant positions

GET /participants/{name}/positions

Tags: participants
Name Description Type Data Type Annotation
name

Name of the participant

path string (2 to 30 chars)
currency

Currency code of the participant

query string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }
default

Successful

Schema definitions

extension: object[]

extensionList: object

extension: extension

limit: object

Participant Limit

type: string

Limit Type

value: number , x ∈ { 0 }

Limit Value

Model 1: object

name: string (2 to 30 chars)

Name of the participant

currency: string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }

Currency code of the participant

Model 10: object

action: string , x ∈ { recordFundsOutCommit , recordFundsOutAbort }
reason: string

Model 2: object

type: string

Endpoint Type

value: string

Endpoint Value

Model 3: object

currency: string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }

Currency code of the participant

limit: limit
initialPosition: number

Initial Position Value

Model 4: object

Participant Limit

type: string

Limit Type

value: number

Limit Value

Model 5: object

currency: string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }

Currency code of the participant

limit: Model 4

Model 6: object

currency: string

Account currency

type: string

Account type

Model 7: object

key: string
value: string

Model 8: object

transferId: string
externalReference: string
action: string , x ∈ { recordFundsOutPrepareReserve , recordFundsIn }
reason: string
amount: No amount provided
extensionList: extensionList

Model 9: object

isActive: boolean

Participant isActive boolean

No amount provided: object

amount: number
currency: string , x ∈ { ALL , AFN , ARS , AWG , AUD , AZN , BSD , BBD , BYN , BZD , BMD , BOB , BAM , BWP , BGN , BRL , BND , KHR , CAD , KYD , CLP , CNY , COP , CRC , HRK , CUP , CZK , DKK , DOP , XCD , EGP , SVC , EUR , FKP , FJD , GHS , GIP , GTQ , GGP , GYD , HNL , HKD , HUF , ISK , INR , IDR , IRR , IMP , ILS , JMD , JPY , JEP , KZT , KPW , KRW , KGS , LAK , LBP , LRD , MKD , MYR , MUR , MXN , MNT , MZN , NAD , NPR , ANG , NZD , NIO , NGN , NOK , OMR , PKR , PAB , PYG , PEN , PHP , PLN , QAR , RON , RUB , SHP , SAR , RSD , SCR , SGD , SBD , SOS , ZAR , LKR , SEK , CHF , SRD , SYP , TWD , THB , TTD , TRY , TVD , UAH , GBP , USD , UYU , UZS , VEF , VND , YER , ZWD }

Currency code of the participant

results matching ""

    No results matching ""