It allows the Participant to enquire its debit position against specific Counterparty BIC not configured for settling in CGS.
POST {{baseUrl}}/debitPosition/:senderBIC
The debitPosition request allows a participant to retrieve any of its debit position against the module or a specific Counterparty BIC. If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response
Request Body
{"dateTime"=>"2019-06-21T23:20:50.000001", "searchCriteria"=>{"interbankSettlementDate"=>"2019-06-21", "cycle"=>"01", "counterpartyBIC"=>"TESTIT88"}, "offset"=>"AAaa88ss2345fggGGDDaaaHH"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
ivUserKey | string | The subscription key of a Participant. cn=<SSO+BIC+UserId+T>,o=BIC8,o=swift. SSO is a fixed string, last char is for environment (P for production and T for test) eg SSOUNCRITMMAPI12345P, o=uncritmm,o=swift | |
ivUserBic | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"dateTime":{},"endOfList":true,"header":{"DPBICCode":"TESTIT88","cycle":"01","interbankSettlementDate":{},"totalPosition":10000.01},"debitPosition":[{"counterpartyBIC":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountDebitReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountDebitSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReturnRefundReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReturnRefundSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReversalReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReversalSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalCreditPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalDebitPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tresholdAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"counterpartyBIC":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountDebitReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountDebitSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReturnRefundReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReturnRefundSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReversalReceived":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sumAmountReversalSent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalCreditPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalDebitPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"totalPosition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tresholdAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"offset":"AAaa88ss2345fggGGDDaaaHH"}