Kard notifications > Notifications API

openapi: 3.2.0
info:
  title: Reference notifications > Notifications API
  version: 1.0.0
servers:
- url: https://rewards-api.getkard.com
  description: Production
- url: https://test-rewards-api.getkard.com
  description: Sandbox
tags:
- name: notifications > Notifications
paths:
  /v2/issuers/{organizationId}/notifications:
    get:
      operationId: list
      summary: List Notifications
      description: 'Lists notifications previously dispatched to the issuer, most recent

        first.


        Results are filterable by event name, delivery status, and a

        `created_at` time range.<br/>

        <b>Required scopes:</b> `notifications:read`'
      tags:
      - notifications > Notifications
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: page[after]
        in: query
        description: Represents a cursor value, and if provided, returns the next page of results
        required: false
        schema:
          type: string
      - name: page[before]
        in: query
        description: Represents a cursor value, and if provided, returns the previous page of results
        required: false
        schema:
          type: string
      - name: page[size]
        in: query
        description: Maximum number of records to be returned [1 - 200], (default = 200)
        required: false
        schema:
          type: integer
      - name: filter[eventName]
        in: query
        description: Return only notifications for this event name.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_NotificationType'
      - name: filter[status]
        in: query
        description: Return only notifications with this delivery status.
        required: false
        schema:
          $ref: '#/components/schemas/type_notifications_notifications_DeliveryStatus'
      - name: filter[after]
        in: query
        description: Return only notifications created strictly after this timestamp (ISO 8601).
        required: false
        schema:
          type: string
          format: date-time
      - name: filter[before]
        in: query
        description: Return only notifications created strictly before this timestamp (ISO 8601).
        required: false
        schema:
          type: string
          format: date-time
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_notifications_notifications_NotificationsListResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
  /v2/issuers/{organizationId}/notifications/{eventId}/replay:
    post:
      operationId: replay
      summary: Replay Notification
      description: 'Re-enqueues a previously dispatched notification so it is redelivered to

        the issuer''s currently configured webhook for that event. Returns 409

        when the issuer has no enabled subscription for the event.<br/>

        <b>Required scopes:</b> `notifications:write`'
      tags:
      - notifications > Notifications
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: eventId
        in: path
        description: The event ID of the notification to replay.
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Response with status 202
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_notifications_notifications_ReplayNotificationResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '409':
          description: Error response with status 409
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
components:
  schemas:
    type_notifications_notifications_NotificationUnion:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - notification
            description: 'Discriminator value: notification'
          id:
            type: string
            description: The event ID of the notification; the value the replay endpoint consumes.
          attributes:
            $ref: '#/components/schemas/type_notifications_notifications_NotificationAttributes'
        required:
        - type
        - id
        - attributes
      discriminator:
        propertyName: type
      title: NotificationUnion
    type_notifications_notifications_NotificationAttributes:
      type: object
      properties:
        eventId:
          type: string
          description: The event ID of the notification.
        eventName:
          $ref: '#/components/schemas/type_commons_NotificationType'
          description: The name of the event.
        timestamp:
          type: string
          format: date-time
          description: When the notification was created.
        lastAttemptAt:
          type: string
          format: date-time
          description: When the most recent delivery attempt was recorded.
        status:
          $ref: '#/components/schemas/type_notifications_notifications_DeliveryStatus'
          description: The delivery status of the notification.
        attempts:
          type: integer
          description: The number of delivery attempts recorded for this notification.
        statusCode:
          type: integer
          description: The HTTP status code returned by the issuer's webhook on the last delivery attempt, when available.
        errorMessage:
          type: string
          description: The error recorded on the last delivery attempt, when delivery failed.
      required:
      - eventId
      - eventName
      - timestamp
      - lastAttemptAt
      - status
      - attempts
      title: NotificationAttributes
    type_notifications_notifications_NotificationsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_notifications_notifications_NotificationUnion'
        meta:
          $ref: '#/components/schemas/type_notifications_notifications_PaginationMetadata'
          description: Metadata about the pagination status.
        links:
          $ref: '#/components/schemas/type_commons_Links'
          description: Links to the current, next, and previous pages.
      required:
      - data
      - meta
      title: NotificationsListResponse
    type_commons_ErrorObject:
      type: object
      properties:
        status:
          type: string
          description: Status code returned from the request
        title:
          type: string
          description: Name of error
        detail:
          type: string
          description: Description of the specific occurance of the error
        source:
          $ref: '#/components/schemas/type_commons_ErrorSource'
          description: An object containing a reference to the primary source of the error
        id:
          type: string
          description: The id of the resource which caused the error. Always returned for multi-status errors.
      required:
      - status
      - title
      - detail
      title: ErrorObject
    type_notifications_notifications_ReplayAcceptedNotification:
      type: object
      properties:
        eventId:
          type: string
          format: uuid
          description: The event ID accepted for replay and queued for delivery.
      required:
      - eventId
      title: ReplayAcceptedNotification
    type_notifications_notifications_PaginationMetadata:
      type: object
      properties:
        pageSize:
          type: integer
          description: Number of items per page.
        hasNextPage:
          type: boolean
          description: Indicates if there are more pages available after the current one.
        total:
          type: integer
          description: Total number of records matching the query (for offset-based pagination).
        page:
          type: integer
          description: Current page number (for offset-based pagination).
      required:
      - pageSize
      - hasNextPage
      description: Response metadata.
      title: PaginationMetadata
    type_notifications_notifications_ReplayNotificationResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_notifications_notifications_ReplayAcceptedNotification'
      required:
      - data
      title: ReplayNotificationResponse
    type_commons_ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_ErrorObject'
      required:
      - errors
      title: ErrorResponse
    type_commons_Links:
      type: object
      properties:
        self:
          type: string
        prev:
          type: string
        next:
          type: string
      required:
      - self
      description: Related links to the API call
      title: Links
    type_commons_NotificationType:
      type: string
      enum:
      - earnedRewardApproved
      - earnedRewardSettled
      - earnedRewardRejected
      - validTransaction
      - failedTransaction
      - clawback
      - auditUpdate
      - fileProcessingResult
      - pushNotificationPlacementFile
      - emailNotificationPlacementFile
      title: NotificationType
    type_commons_OrganizationId:
      type: string
      description: Your issuer organization ID, provided by Kard
      title: OrganizationId
    type_commons_ErrorSource:
      type: object
      properties:
        pointer:
          type: string
          description: A JSON pointer to the value in the request document that caused the error
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error
        header:
          type: string
          description: A string indicating the name of a single request header which caused the error
      title: ErrorSource
    type_notifications_notifications_DeliveryStatus:
      type: string
      enum:
      - pending
      - delivered
      - delivery_failed
      description: The delivery status of a notification.
      title: DeliveryStatus
  securitySchemes:
    OAuthScheme:
      type: http
      scheme: bearer