Logo
Swift API Sandbox Collections API Documentation

A Participant can inquiry real time liquidity position.

POST {{baseUrl}}/currentNetPosition/:senderBic

The Current Position request allows the Participant to inquire about its real time liquidity position in the SCT Inst. Upon receiving this Request, the SCT Inst will inquire the real time Position of the inquiring Participant and returns the value of the timestamp of the reading. The result of the inquiry done for a Participant that is not part of a Liquidity Pool will always be a positive value. If the Participant belongs to a Liquidity Pool, it is possible that the Current Position is a negative value. The SCT Inst will always verify if the Participant is part of a Liquidity Pool, if this the case the Response will contain the Position of both the Participant and the Position of all Liquidity Pools the Participant is a member of. The response contains the current Position of the Participant. If the Participant is an LP, the system will return the current Position of each LSP for whose liquidity management it is responsible for. In the case that the Participant is a member of one or more Liquidity Pools, the “PoolId” and “PoolPosition” elements contain the Pool identification and the current position of the Pool to which the Participant belongs to. If the Participant is the Owner of one or more Liquidity Pools, the section “OwnedPool” is repeated for each Liquidity Pool that is owns. The “OwnedMember” for each “OwnedPool” lists the members of the Pool and the Position of each member.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
ivUserKey
string The subscription key of a Participant. Following the format cn=<SSO+BIC+UserId+T>,o=BIC8,o=swift. SSO is a fixed string, last character is for environment (P for production and T for test) eg SSOUNCRITMMAPI12345P, o=uncritmm,o=swift
ivUserBic
string
Accept
string




RESPONSES

status OK

{ "dateTime": "2019-06-21T23:20:50.000001", "senderPosition": { "bic": "IPSDID21", "sign": "C", "amount": 237631527637.12518, "timestamp": "2019-06-21T23:20:50.000001" }, "lspsPosition": [ { "bic": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "sign": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "amount": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "timestamp": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, { "bic": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "sign": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "amount": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "timestamp": { "value": "<Error: Too many levels of nesting to fake this schema>" } } ], "poolPosition": { "poolId": "IPSDID21XXX01", "amount": 549528677131.3893 }, "ownedPoolList": [ { "ownedPoolInfo": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "ownedMemberList": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ] }, { "ownedPoolInfo": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "ownedMemberList": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ] } ] }



Curl
curl -X POST 'https://sandbox.swift.com/ebacl-rt1/v1/currentNetPosition/:senderBic' -H 'ivUserKey: quis fugiat aute dolore' -H 'ivUserBic: IPSDID21' -H 'Accept: application/json'

ENDPOINTS