Swift API Sandbox Collections API Documentation
It allows the Participant to inquire its debit position against specific Counterparty BIC not configured for settling in CGS.
POST {{baseUrl}}/debitPosition/:senderBIC
The debitPosition request allows participants to retrieve their debit position to be settled in T2I against the System or a specific Counterparty BIC configured for settling in T2I. If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
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 | ||
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"dateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"endOfList": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"header": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"debitPosition": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"offset": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-sct/v1/debitPosition/:senderBIC' -H 'ivUserKey: culpa quis officia ut in' -H 'ivUserBic: TESTIT88' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","searchCriteria":{"interbankValueDate":"2019-06-21","settlementCycle":"01","counterpartyBIC":"TESTIT88"},"offset":"AAaa88ss2345fggGGDDaaaHH"}'
ENDPOINTS