Azeez Muibi
59 lines
2.2 KiB
JSON
59 lines
2.2 KiB
JSON
{
|
|
"post": {
|
|
"tags": [
|
|
"NotificationCallback"
|
|
],
|
|
"summary": "Notification Callback",
|
|
"description": "This new feature will be used for informing Simbrella about status of the transactions that FBN have processed. Retry mechanism should be implemented by FirstBank in case of connection issues, sending notification should be repeated for 5 minutes in case of there is connection issues, after which Simbrella will try to check the status of transaction with New Transaction Check endpoint. FBN should provide a list of Response Codes with corresponding Response Descriptions for notifications. Please note that AmountCollected field will equal to 0 when transaction type is Disbursement. AmountProvided field will equal to 0 when transaction type is Collection or PenalCharge.",
|
|
"operationId": "notificationCallback",
|
|
"requestBody": {
|
|
"description": "Transaction status notification from FirstBank to Simbrella",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../schemas/NotificationCallbackRequest.json"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "../schemas/NotificationCallbackRequest.json"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "../schemas/NotificationCallbackRequest.json"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Notification received successfully",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../schemas/NotificationCallbackResponse.json"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "../schemas/NotificationCallbackResponse.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid request"
|
|
},
|
|
"500": {
|
|
"description": "Internal server error"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"basic_auth": []
|
|
}
|
|
]
|
|
}
|
|
} |