Swift API Sandbox Collections API Documentation
Get notifications for a subscription.
GET {{baseUrl}}/subscriptions/{{subscription-id}}/notifications?maxSize=10
A client can invoke this API if they want to recieve consume notifications from a category(Queue) they subscribe to.
Body
PARAM
| Key | Datatype | Required | Description |
maxSize
|
number | It denotes the maximum number of notifications in a batch that are allowed to be received from a category(Queue) for a given service. If provided value by the subscriber is between 1 and 100 then the provided value will be taken. If the provided value if greater than 100, then the global max 100 will be taken. If a subscriber doesn't provide a value for maxSize query parameter of Get notifications API call, no error will be thrown , the value for the parameter batch_size_max that was provided during subscription creation was given will be taken then. If during subscription the value for batch_size_max was not provided then the value of the global parameter which is 100 will be taken. For any invalid provided values, an error is thrown. |
HEADERS
| Key | Datatype | Required | Description |
notif-role
|
string | (Required) Header that identifies role of the requester to validate if its a provider or consumer. Added by the client in the request. |
RESPONSES
status OK
| {
"notifications": [
{
"service_name": "swift.gpi",
"category": "Settlement",
"recipient_institution": "CITIUS33",
"content": {
"Come get your settlement info!": null
}
},
{
"service_name": "swift.gpi",
"category": "Settlement",
"recipient_institution": "CITIUS33",
"content": {
"Come get your settlement info!": null
}
}
]
} |
Curl
curl -X GET 'https://sandbox.swift.com/swift-notif/v1/subscriptions/subscription-id/notifications?maxSize=10?maxSize=10' -H 'notif-role: Y29uc3VtZXI='
ENDPOINTS