It provides the list of the Standard Settlement Instructions (SSI's) stored in the service. The SSI's refer to a Legal Entities Settlement Instruction for which key information remains the same from one cash settlement to another. The data in our database is taken from the Swift Files downloaded monthly.
It has the possibility to apply filters and to sort them.
OAuth Grant type, JWT Profile
Identifies the client of the api
Amount of results to retrieve
Results to skip
Sorting order for the results. Possible values:
- +created_at: ascending creation dates
- -created_at: descending creation dates If the value is omitted, the default value is '-created_at'"
BIC code.
ISO Currency code filter
Asset category filter.
Returns a list of SSIs (possibly filtered) with pagination
SSIs information response
{
"data": [
{
"owner": {
"bic": "DEUTDEFFXXX",
"institutionName": "Deutsche Bank AG",
"city": "FRANKFURT AM MAIN",
"isoCountryCode": "DE"
},
"isoCurrencyCode": "USD",
"assetCategory": "MMKT",
"accountHoldingInstitution": {
"bic": "CITIUS33XXX",
"institutionName": "CITIBANK N.A.",
"isoCountryCode": "US",
"accountNumber": "7892398045980",
"preferred": true,
"institutionType": "CORRESPONDENT"
},
"trafficFlag": true,
"trafficDate": "2023-10-26T02:00:00.000Z",
"updateDate": "2023-10-26T02:00:00.000Z",
"startDate": "2023-10-26T02:00:00.000Z",
"stopDate": "2023-10-26T02:00:00.000Z"
}
],
"_count": "1",
"_links": {
"_first": "/endpoint?_offset=0&_limit=10",
"_last": "/endpoint?_offset=10&_limit=10",
"_prev": "/endpoint?_offset=30&_limit=10",
"_next": "/endpoint?_offset=40&_limit=10"
}
}Array of data returned when asking for the SSI's information
Data response
Ssi information returned
Onwer properties
BIC
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Currency ISO code
Asset categories for SSIs
Account properties
BIC
Specifies a character string with a maximum length of 70 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Specifies a character string with a maximum length of 70 characters.
Ssi account preferred value
Ssi account institution type
Ssi traffic flag
Date time
Date time
Date time
Date time
Pagination count
Pagination links
Link to the first page of the list of results
Link to the last page of the list of results
Link to the previous page of the list of results
Link to the last page of the list of results
No Content
Bad Request
{
"errors": [
{
"code": "400",
"message": "BAD_REQUEST",
"level": "FATAL",
"description": "Bad request"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
User not authorized
{
"errors": [
{
"code": "401",
"message": "UNAUTHORIZED",
"level": "FATAL",
"description": "User unauthorized"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Access forbidden
{
"errors": [
{
"code": "403",
"message": "FORBIDDEN",
"level": "ERROR",
"description": "Access forbidden"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not Found
Not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "Not found"
}
]
}The Correspondent was not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "Correspondent could not be found"
}
]
}{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "No Route was found"
}
]
}The Requested account data is not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "The requested Account Number is not a valid _accountFormat_ account"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
The Accept header does not specifically contains one of the allowable types, usually 'application/json'
{
"errors": [
{
"code": "406",
"message": "NOT_ACCEPTABLE",
"level": "ERROR",
"description": "Accept header is not application/json"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Most web servers have a limit of 8192 bytes (8 KB). The server will close the connection to prevent the client from continuing the request.
{
"errors": [
{
"code": "413",
"message": "REQUEST_ENTITY_TOO_LARGE",
"level": "ERROR",
"description": "Request entity larger than 8192 bytes - 8KB"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
URI request is longer than 2,000 characters
{
"errors": [
{
"code": "414",
"message": "URI_TOO_LONG",
"level": "ERROR",
"description": "URI request is longer than 2000 characters"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unprocessable Entity
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "Unprocessable entity"
}
]
}{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "unexpected keys on object - wrong_key"
}
]
}The requested parameters contain an invalid Currency value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - currency - It must be present in routeParams or extraDetails pacs - IntrBkSttlmAmt.Ccy"
}
]
}The requested parameters contain an invalid account format/number value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - accountFormat or accountNumber - They must be present in routeParams or extraDetails pacs - IntrmyAgt1.FinInstnId CdtrAcct.Id.IBAN or CdtrAgt.FinInstnId"
}
]
}The requested parameters contain an invalid Charge Type value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - chargeType - No union satisfied. expected value to be literal OUR but got foobar expected value to be literal BEN but got foobar expected value to be literal SHA but got foobar"
}
]
}The requested parameters contain an invalid Origin Bank value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - originBank - expected string to match pattern but did not"
}
]
}The requested parameters contain an invalid Origin Country value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - originCountry - expected string to match pattern but did not"
}
]
}The requested parameters contain an invalid Payment Amount value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - paymentAmount - expected type to be number but got string"
}
]
}The requested parameters contain an invalid Value Percentage value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - volumePercentage - expected number to be less than or equal to 100 but got 999999"
}
]
}The requested parameters contain an invalid Permanent Input value
Permanent Inputs: sameCorrespondent, volumePercentage, searchIntermediary, commonCorrespondent.
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - sameCorrespondent - No union satisfied. expected string to be one of - true false. expected type to be boolean but got string"
}
]
}The Request parameters contain an invalid Clearing Scheme value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - clearingScheme - expected string to match pattern but did not"
}
]
}The Request parameters contain an invalid Service Code value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - serviceCode - expected string to match pattern but did not"
}
]
}The Request parameters contain an invalid SSI Correspondent Steps value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - ssiCorrespondentSteps - expected number to be less than or equal to 10 but got 11"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
The user has sent too many requests in a given amount of time
{
"errors": [
{
"code": "429",
"message": "TOO_MANY_REQUESTS",
"level": "ERROR",
"description": "Too many requests"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal Server Error
Internal Server Error
{
"errors": [
{
"code": "500",
"message": "INTERNAL_SERVER_ERROR",
"level": "ERROR",
"description": "Unknown error caught in the error middleware"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Service is unavailable
{
"errors": [
{
"code": "503",
"message": "SERVICE_UNAVAILABLE",
"level": "ERROR",
"description": "Service is unavailable"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Gateway timeout
{
"errors": [
{
"code": "504",
"message": "GATEWAY_TIMEOUT",
"level": "ERROR",
"description": "Gateway timeout"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal Server Error
Internal Server Error
{
"errors": [
{
"code": "500",
"message": "INTERNAL_SERVER_ERROR",
"level": "ERROR",
"description": "Unknown error caught in the error middleware"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue