Create a Notification resend task

POST 
/v2/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

status NotificationTaskStatus (string)

Possible values: [SCHEDULED, IN_PROGRESS, FINISHED, FAILED, CANCELLED]

Status of the task.

eventType NotificationEventType (string)required

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.

startDate date-timerequired

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.

endDate date-timerequired

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.

merchantRefNum string

Possible values: <= 50 characters

Re-send notifications associated to a merchant reference number.

customerIds string[]

Possible values: <= 1000

Re-send notifications associated to a list of customers.

accountIds string[]

Possible values: <= 1000

Re-send notifications associated to a list of accounts.

merchantRefNums string[]

Possible values: <= 1000

List of merchantRefNum

notificationsToResend int64

Number of notifications to be re-sent.

notificationsResent int64

Number of notifications already re-sent.

Responses

201

Created

application/json

Schema

Schema

id string

Possible values: <= 20 characters

Server generated ID of the task.

status NotificationTaskStatus (string)

Possible values: [SCHEDULED, IN_PROGRESS, FINISHED, FAILED, CANCELLED]

Status of the task.

eventType NotificationEventType (string)required

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.

startDate date-timerequired

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.

endDate date-timerequired

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.

merchantRefNum string

Possible values: <= 50 characters

Re-send notifications associated to a merchant reference number.

customerIds string[]

Possible values: <= 1000

Re-send notifications associated to a list of customers.

accountIds string[]

Possible values: <= 1000

Re-send notifications associated to a list of accounts.

merchantRefNums string[]

Possible values: <= 1000

List of merchantRefNum

notificationsToResend int64

Number of notifications to be re-sent.

notificationsResent int64

Number of notifications already re-sent.

Example (from schema)

{
  "id": "string",
  "status": "SCHEDULED",
  "eventType": "TRANSACTION",
  "startDate": "2024-11-12T16:34:35.707Z",
  "endDate": "2024-11-12T16:34:35.707Z",
  "merchantRefNum": "string",
  "customerIds": [
    "string"
  ],
  "accountIds": [
    "string"
  ],
  "merchantRefNums": [
    "string"
  ],
  "notificationsToResend": 0,
  "notificationsResent": 0
}

POST_NOTIFICATION_RESEND_TASK

{
  "id": "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
}

400

Bad Request

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

503

Service Unavailable. Please try again later.

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

Loading...