openapi: 3.1.0
info:
  license:
    name: Worldpay
    url: developers.worldpay.com/license
  title: Events
  description: >-
    Receive status updates from Access Worldpay by setting up a webhook.


    Contact your Implementation Manager to add your webhook URL and enable or
    disable the events based on your requirement


    The webhook destination (URL) must use an encrypted connection (https) and
    must also have a certificate signed by a trusted certificate authority.


    <style>  
      [class*="tag-post"] {  
          display: none;
      }
    </style>
  version: '1'
  x-metadata:
    category:
      - Webhooks
    business:
      - Enterprise
    catalog-list: true
    generated: false
servers:
  - url: https://merchant-defined-url.com
    description: Merchant Webhook Path
security: []
externalDocs:
  description: Developer Documentation
  url: https://developer.worldpay.com/products/access/events
tags:
  - name: payment
    description: 'Recieve payment events/webhooks to a URL defined by you. '
  - name: payout
    description: 'Recieve payout events/webhooks to a URL defined by you. '
  - name: chargeback
    description: 'Recieve chargeback events/webhooks to a URL defined by you.  '
webhooks:
  sentForAuthorization:
    post:
      tags:
        - payment
      summary: sentForAuthorization
      operationId: sentForAuthorizationPayment
      requestBody:
        description: >-
          We've requested permission (from your customer's card issuer) to
          process your customer's payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sentForAuthorizationPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  authorized:
    post:
      tags:
        - payment
      summary: authorized
      operationId: authorizedPayment
      requestBody:
        description: >-
          The payment has been approved and the funds have been reserved in your
          customer's account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/authorizedPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  sentForSettlement:
    post:
      tags:
        - payment
      summary: sentForSettlement
      operationId: sentForSettlementPayment
      requestBody:
        description: >-
          You or Access Worldpay have requested to remove the reserved funds in
          your customer's account and transfer them to your Worldpay account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sentForSettlementPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  settled:
    post:
      tags:
        - payment
      summary: settled
      operationId: settledPayment
      requestBody:
        description: >
          We have received the funds and are preparing to transfer them to your
          bank account.

          This event is only available in certain use cases. Please speak to
          your Implementation Manager for more details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/settledPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  settlementFailed:
    post:
      tags:
        - payment
      summary: settlementFailed
      operationId: settlementFailedPayment
      requestBody:
        description: >
          The settlement couldn't be processed and funds have not been
          transferred to your Worldpay account.

          This event is only available in certain use cases. Please speak to
          your Implementation Manager for more details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/settlementFailedPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  cancelled:
    post:
      tags:
        - payment
      summary: cancelled
      operationId: cancelledPayment
      requestBody:
        description: >
          You have stopped the transaction before it has been sent for
          settlement.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cancelledPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  error:
    post:
      tags:
        - payment
      summary: error
      operationId: errorPayment
      requestBody:
        description: >
          The payment wasn't completed. Your customer may want to reattempt the
          payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/errorPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  expired:
    post:
      tags:
        - payment
      summary: expired
      operationId: expiredPayment
      requestBody:
        description: >
          The authorization period ended before a settlement or cancel request
          was made.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/expiredPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  refused:
    post:
      tags:
        - payment
      summary: refused
      operationId: refusedPayment
      requestBody:
        description: |
          Your payment request has been declined by a third party.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refusedPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  sentForRefund:
    post:
      tags:
        - payment
      summary: sentForRefund
      operationId: sentForRefundPayment
      requestBody:
        description: >
          You've requested funds to be sent back to your customer's account. If
          online authorization was required, this will also contain the
          `refund.onlineRefundAuthorization`.

          __Payouts through basic disbursement triggers this event.__
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sentForRefundPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  refunded:
    post:
      tags:
        - payment
      summary: refunded
      operationId: refundedPayment
      requestBody:
        description: >
          The card issuer has received the refund request and they will return
          the funds to your customer's account. This event is only available in
          certain use cases. Please speak to your Implementation Manager for
          more details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refundedPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  refundFailed:
    post:
      tags:
        - payment
      summary: refundFailed
      operationId: refundFailedPayment
      requestBody:
        description: >
          The refund couldn't be processed and the funds were returned to your
          account. If online authorization was required, this will also contain
          the `refund.refusal.code` and `refund.refusal.description`.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refundFailedPayment'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  tokenCreated:
    post:
      tags:
        - payment
      summary: tokenCreated
      operationId: tokenCreatedPayment
      requestBody:
        description: >
          You have successfully created a Klarna token. For further information
          of the fields returned see our table.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tokenCreated'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  disbursed:
    post:
      tags:
        - payout
      summary: disbursed
      operationId: disbursedPayout
      requestBody:
        description: |
          Your Fast Access disbursement request has been disbursed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/disbursedPayout'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  pending:
    post:
      tags:
        - payout
      summary: pending
      operationId: pendingPayout
      requestBody:
        description: >
          Your Fast Access disbursement request has been sent to Visa Direct,
          and a response is pending. Pending requests usually update to approved
          or refused within 45 minutes. If no response is received within 48
          hours, an error is returned.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pendingPayout'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  refusedPayout:
    post:
      tags:
        - payout
      summary: refused
      operationId: refusedPayout
      requestBody:
        description: |
          Your Fast Access disbursement request was refused.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refusedPayout'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  requestedPayout:
    post:
      tags:
        - payout
      summary: requested
      operationId: requestedPayout
      requestBody:
        description: |
          Access Payouts has received your Fast Access disbursement request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requestedPayout'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  approvedPayout:
    post:
      tags:
        - payout
      summary: approved
      operationId: approvedPayout
      requestBody:
        description: >
          Visa Direct has approved your Fast Access disbursement request. Your
          customer should receive the funds within 30 minutes if their issuer is
          Fast Access enabled, or 3-5 working days if they are not.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/approvedPayout'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
  informationRequested:
    post:
      tags:
        - chargeback
      summary: informationRequested
      operationId: informationRequestedChargeback
      requestBody:
        description: >
          Your customer has disputed this payment with their card issuer. The
          card issuer has requested information about the payment and the
          disputed funds have been held until the outcome of the dispute. This
          event is only available in certain use cases. Please speak to your
          Implementation Manager for more details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/informationRequestedChargeback'
      responses:
        '200':
          description: >-
            Return a 200 status to indicate that the data was received
            successfully
components:
  schemas:
    eventId:
      type: string
      description: The unique identifier for the event
      example: bb55ca5a-e05c-47e1-8e94-e88bac1a0a17
    eventTimestamp:
      type: string
      description: Date of event
      example: '2018-06-13T14:18:13.407'
    amount:
      type: object
      properties:
        value:
          type: integer
          format: int32
          description: >-
            The authorization, partial refund, or the whole or partial
            settlement amount. This is a whole number with an exponent of 2 e.g.
            250 would be 2.50.
          example: 100
        currencyCode:
          type: string
          description: The currency code
          example: EUR
    downstreamReference:
      type: string
      description: A reference you can use for reconciliation purposes
      example: '3378792436'
    transactionReference:
      type: string
      description: The transaction reference you supplied in the payment
      example: Memory265-13/08/1876
    date:
      type: string
      format: date
      description: The date you first submitted the payment
      example: '2017-11-03'
    reference:
      type: string
      description: >-
        The unique reference you provided for a partial settlement or partial
        refund
      example: '12345'
    octReference:
      type: string
      description: >-
        Visa Transaction ID for single-message OCTs to be used for
        reconciliation and reporting. Can be returned in the `sentForRefund` or
        `refused` Payment Events
      example: '12345'
    refund:
      type: object
      properties:
        onlineRefundAuthorization:
          type: string
          description: >
            Authorization code from the issuer for online refunds. Additional
            information returned as part of a Visa and Mastercard mandate to
            ensure that all purchase returns are submitted for online
            authorization. 
          example: '987654'
    refundRefusal:
      type: object
      properties:
        refusal:
          type: object
          properties:
            code:
              type: string
              description: Refusal code for online refund authorization
              example: '5'
            description:
              type: string
              description: Refusal description for online refund authorization
              example: Do not honor
    _links:
      type: object
      description: Unused currently
      properties:
        payment:
          type: object
          properties:
            href:
              type: string
              example: ''
    sentForAuthorizationPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: sentForAuthorization
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    authorizedPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: authorized
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    sentForSettlementPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: sentForSettlement
            date:
              $ref: '#/components/schemas/date'
            reference:
              $ref: '#/components/schemas/reference'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    settledPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: settled
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    settlementFailedPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: settlementFailed
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    cancelledPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: cancelled
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    errorPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: error
            date:
              $ref: '#/components/schemas/date'
            _links:
              $ref: '#/components/schemas/_links'
    expiredPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: expired
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    refusedPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: refused
            date:
              $ref: '#/components/schemas/date'
            octReference:
              $ref: '#/components/schemas/octReference'
            _links:
              $ref: '#/components/schemas/_links'
    sentForRefundPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: sentForRefund
            date:
              $ref: '#/components/schemas/date'
            reference:
              $ref: '#/components/schemas/reference'
            refund:
              $ref: '#/components/schemas/refund'
            octReference:
              $ref: '#/components/schemas/octReference'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    refundedPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: refunded
            date:
              $ref: '#/components/schemas/date'
            refund:
              $ref: '#/components/schemas/refund'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    refundFailedPayment:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            downstreamReference:
              $ref: '#/components/schemas/downstreamReference'
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: refundFailed
            date:
              $ref: '#/components/schemas/date'
            reference:
              $ref: '#/components/schemas/reference'
            refund:
              $ref: '#/components/schemas/refundRefusal'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
    tokenCreated:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payment
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            tokenCreatedAt:
              type: string
              format: date-time
              example: '2024-04-23T18:51:28Z'
            tokenPaymentInstrument:
              type: object
              properties:
                type:
                  type: string
                  example: token
                tokenId:
                  type: string
                  example: '9981080858023992994'
            tokenExpiryDateTime:
              type: string
              format: date-time
              example: '2024-04-30T18:51:27Z'
            paymentInstrument:
              type: object
              properties:
                method:
                  type: string
                  example: klarna
                countryCode:
                  type: string
                  example: GB
                billingAddress:
                  type: object
                  properties:
                    address1:
                      type: string
                      example: 221B Baker Street
                    address2:
                      type: string
                      example: Marylebone
                    address3:
                      type: string
                      example: Westminster
            productType:
              type: string
              enum:
                - payLater
              example: payLater
    disbursedPayout:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payout
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: disbursed
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
    pendingPayout:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payout
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: pending
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
    refusedPayout:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payout
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: refused
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
    requestedPayout:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payout
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: requested
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
    approvedPayout:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: payout
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: approved
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
    informationRequestedChargeback:
      properties:
        eventId:
          $ref: '#/components/schemas/eventId'
        eventTimestamp:
          $ref: '#/components/schemas/eventTimestamp'
        eventDetails:
          type: object
          properties:
            classification:
              type: string
              description: >-
                The event category, this can either be payout, payment or
                chargeback
              example: chargeback
            transactionReference:
              $ref: '#/components/schemas/transactionReference'
            type:
              type: string
              description: >-
                Event status. For example, `cancelled` or
                `sentForAuthorization`.
              example: informationRequested
            date:
              $ref: '#/components/schemas/date'
            amount:
              $ref: '#/components/schemas/amount'
            _links:
              $ref: '#/components/schemas/_links'
