Create a Notification resend task
POST/notifications/tasks
Create a new Notification resend task. This background task will trigger re-send of web hook notifications by client specified criteria.
Request
- application/json
Body
Possible values: [SCHEDULED
, IN_PROGRESS
, FINISHED
, FAILED
, CANCELLED
]
Status of the task.
Possible values: [TRANSACTION
, RESTRICTION
, ACCOUNT
, KYC
, INSTRUMENT
, SCREENING
, CARD_STATUS_UPDATE
, CARD_TOKENIZATION
, CARD_TOKEN_UPDATE
, THREE_D_SECURE
, CARD_BULK_ORDER
]
Type of notification events that will be re-sent.
Re-send notifications created during period specified by startDate and endDate properties. Further restrictions of the maximum period length may be enforced by the server.
Re-send notifications created during period specified by startDate and endDate properties. Further restrictions of the maximum period length may be enforced by the server.
Possible values: <= 50 characters
Re-send notifications associated to a merchant reference number.
Possible values: <= 1000
Re-send notifications associated to a list of customers.
Possible values: <= 1000
Re-send notifications associated to a list of accounts.
Possible values: <= 1000
List of merchantRefNum
Number of notifications to be re-sent.
Number of notifications already re-sent.
Responses
- 201
- 400
- 500
- 503
Created
- application/json
- Schema
- Example (from schema)
- POST_NOTIFICATION_RESEND_TASK
Schema
Possible values: <= 20 characters
Server generated ID of the task.
Possible values: [SCHEDULED
, IN_PROGRESS
, FINISHED
, FAILED
, CANCELLED
]
Status of the task.
Possible values: [TRANSACTION
, RESTRICTION
, ACCOUNT
, KYC
, INSTRUMENT
, SCREENING
, CARD_STATUS_UPDATE
, CARD_TOKENIZATION
, CARD_TOKEN_UPDATE
, THREE_D_SECURE
, CARD_BULK_ORDER
]
Type of notification events that will be re-sent.
Re-send notifications created during period specified by startDate and endDate properties. Further restrictions of the maximum period length may be enforced by the server.
Re-send notifications created during period specified by startDate and endDate properties. Further restrictions of the maximum period length may be enforced by the server.
Possible values: <= 50 characters
Re-send notifications associated to a merchant reference number.
Possible values: <= 1000
Re-send notifications associated to a list of customers.
Possible values: <= 1000
Re-send notifications associated to a list of accounts.
Possible values: <= 1000
List of merchantRefNum
Number of notifications to be re-sent.
Number of notifications already re-sent.
{
"id": "string",
"status": "SCHEDULED",
"eventType": "TRANSACTION",
"startDate": "2024-11-12T16:34:38.730Z",
"endDate": "2024-11-12T16:34:38.730Z",
"merchantRefNum": "string",
"customerIds": [
"string"
],
"accountIds": [
"string"
],
"merchantRefNums": [
"string"
],
"notificationsToResend": 0,
"notificationsResent": 0
}
{
"id": "c4b7b1ad-10ad-47d0-92d4-8ea1d02a558b",
"status": "SCHEDULED",
"eventType": "RESTRICTION",
"startDate": "2021-07-15T17:54:12Z",
"endDate": "2021-07-16T17:54:12Z",
"merchantRefNum": "1000000123",
"customerIds": [],
"accountIds": [],
"merchantRefNums": [],
"notificationsToResend": 100,
"notificationsResent": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
Service Unavailable. Please try again later.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}