openapi: 3.0.1
info:
  title: Dispute Webhooks OpenAPI Specification
  description: >-
    This is the documentation for the Ratepay dispute webhooks. The webhooks are
    still in development and subject to change. This documentation will evolve
    as the development of the webhooks progresses.
  contact:
    name: Ratepay
    url: https://www.ratepay.com/
    email: info@ratepay.com
  version: version
paths:
  /webhook-rfi(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: ITEM_NOT_RECEIVED
      operationId: ItemNotReceived
      description: Webhook payload for the ITEM_NOT_RECEIVED request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 2vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: ' Date and time of publication of the request for information. Format in accordance with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).'
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                comment:
                  type: string
                  description: >-
                    Additional information about the buyer's problem
                    description.
                  example: >-
                    Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde
                    retourniert.
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: ITEM_NOT_RECEIVED
                  enum:
                    - ITEM_NOT_RECEIVED
                response_due_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time by which the evidence for the case can be
                    provided. Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-03-11T00:00:00.12+00:00'
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                items:
                  type: array
                  items:
                    type: object
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-outcome(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: Outcome for ITEM_NOT_RECEIVED
      operationId: OutcomeForItemNotReceived
      description: >-
        Outcome webhook payload for the ITEM_NOT_RECEIVED request for
        information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 2vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: ITEM_NOT_RECEIVED
                  enum:
                    - ITEM_NOT_RECEIVED
                resolution_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time when the resolution webhook was created.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-04-17T00:00:00.12+00:00'
                resolution_reason:
                  type: string
                  description: The resolution reason may be CLOSED, CHARGEBACK or FRAUD.
                  example: CLOSED
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-return(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: ITEM_RETURNED
      operationId: ItemReturned
      description: Webhook payload for the ITEM_RETURNED request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 2vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                comment:
                  type: string
                  description: >-
                    Additional information about the buyer's problem
                    description.
                  example: >-
                    Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde
                    retourniert.
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: ITEM_RETURNED
                  enum:
                    - ITEM_RETURNED
                response_due_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time by which the evidence for the case can be
                    provided. Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-03-11T00:00:00.12+00:00'
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+02:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                tracking_code:
                  type: array
                  items:
                    type: object
                    properties:
                      carrier_name:
                        type: string
                        description: >-
                          Name of the shipping carrier used by the shop for the
                          capture.
                        example: DHL
                      tracking_number:
                        type: string
                        description: Tracking number for order delivery.
                        example: JJD0099999999
                items:
                  type: array
                  items:
                    type: object
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-return-outcome(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: Outcome for ITEM_RETURNED
      operationId: OutcomeForItemRefund
      description: Outcome webhook payload for the ITEM_RETURNED request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 7vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: ITEM_RETURNED
                  enum:
                    - ITEM_RETURNED
                resolution_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time when the resolution webhook was created.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-04-17T00:00:00.12+00:00'
                resolution_reason:
                  type: string
                  description: The resolution reason may be CLOSED or CHARGEBACK.
                  example: CLOSED
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-defend(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: DEFEND
      operationId: Defend
      description: Webhook payload for the DEFEND request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 2vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                comment:
                  type: string
                  description: >-
                    Additional information about the buyer's problem
                    description.
                  example: >-
                    Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde
                    retourniert.
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: DEFEND
                  enum:
                    - DEFEND
                response_due_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time by which the evidence for the case can be
                    provided. Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-03-11T00:00:00.12+00:00'
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                items:
                  type: array
                  items:
                    type: object
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-defend-outcome(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: Outcome for DEFEND
      operationId: OutcomeForDefend
      description: Outcome webhook payload for the DEFEND request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 7vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: DEFEND
                  enum:
                    - DEFEND
                resolution_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time when the resolution webhook was created.
                    Format conforming to [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-04-17T00:00:00.12+00:00'
                resolution_reason:
                  type: string
                  description: The resolution reason may be CLOSED or CHARGEBACK.
                  example: CLOSED
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-fraud(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: FRAUD
      operationId: Fraud
      description: Webhook payload for the FRAUD request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 2vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                comment:
                  type: string
                  description: >-
                    Additional information about the buyer's problem
                    description.
                  example: >-
                    Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde
                    retourniert.
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: FRAUD
                  enum:
                    - FRAUD
                response_due_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time by which the evidence for the case can be
                    provided. Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-03-11T00:00:00.12+00:00'
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                tracking_code:
                  type: array
                  items:
                    type: object
                    properties:
                      carrier_name:
                        type: string
                        description: >-
                          Name of the shipping carrier used by the shop for the
                          capture.
                        example: DHL
                      tracking_number:
                        type: string
                        description: Tracking number for order delivery.
                        example: JJD0099999999
                items:
                  type: array
                  items:
                    type: object
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
  /webhook-rfi-fraud-outcome(to de defined):
    parameters:
      - name: x-signature
        in: header
        description: The hashed (SHA-512) payload.
        required: false
        schema:
          type: string
          minLength: 128
          maxLength: 128
        example: >-
          1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
      - name: Authorization
        in: header
        description: >-
          For each request, a valid access token must be provided in the
          Authorization header. See                       [Authentication
          API](/docs/developer/authentication/authentication/) for obtaining a
          valid token.
        required: true
        schema:
          type: string
    post:
      summary: Outcome for FRAUD
      operationId: OutcomeForFraud
      description: Outcome webhook payload for the FRAUD request for information.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ratepay_transaction_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: >-
                    The identifier for the transaction provided by Ratepay in
                    the response to the authorization request.
                  example: 7vqgHujqswxwqa7Ms9Q1
                ratepay_dispute_id:
                  type: string
                  minLength: 20
                  maxLength: 20
                  description: The dispute ID generated by Ratepay.
                  example: 6vqgHujqswxwqa7Ms9Q1
                partner_transaction_id:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: The identifier for the transaction generated by the partner.
                  example: partner-transaction-id-1234
                publication_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time of publication of the request for information.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-02-19T15:00:00.05+00:00'
                amount:
                  type: number
                  description: >-
                    The amount of the request for information, as requested by
                    the buyer.
                  example: 529.9
                  minimum: 0
                  multipleOf: 0.01
                  exclusiveMinimum: true
                currency:
                  type: string
                  pattern: '[A-Z]{3}'
                  description: >-
                    The currency of all amounts pertaining to the transaction.
                    Upper-case alphabetic code in accordance with [ISO
                    4217](https://en.wikipedia.org/wiki/ISO_4217).
                  example: EUR
                type:
                  type: string
                  description: Indicates the type of dispute webhook notification.
                  example: REQUEST_FOR_INFORMATION
                  enum:
                    - REQUEST_FOR_INFORMATION
                reason:
                  type: string
                  description: >-
                    The reason of a REQUEST_FOR_INFORMATION may be DEFEND,
                    ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.
                  example: FRAUD
                  enum:
                    - FRAUD
                resolution_date:
                  type: string
                  format: date-time
                  description: >-
                    Date and time when the resolution webhook was created.
                    Format in accordance with [ISO
                    8601](https://en.wikipedia.org/wiki/ISO_8601).
                  example: '2021-04-17T00:00:00.12+00:00'
                resolution_reason:
                  type: string
                  description: The resolution reason is always CLOSED.
                  example: CLOSED
                captures:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                        description: >-
                          The date when Ratepay received the capture call.
                          Format in accordance with [ISO
                          8601](https://en.wikipedia.org/wiki/ISO_8601).
                        example: '2021-02-03T19:09:00.12+00:00'
                      partner_operation_id:
                        type: string
                        maxLength: 255
                        minLength: 0
                        description: >-
                          The operation ID of the respective capture operations
                          included in the request for information, as
                          transmitted by the partner.
                        example: '7816171225883407'
                      ratepay_payment_reference:
                        type: string
                        minLength: 10
                        maxLength: 127
                        description: >-
                          The payment reference Ratepay communicates to the
                          buyer for the bank transfer.
                        example: GE7671626N4
                      ratepay_capture_id:
                        type: string
                        maxLength: 127
                        minLength: 20
                        pattern: '[A-Za-z0-9-_]{20,127}'
                        description: >-
                          The capture ID provided by Ratepay in the response to
                          the capture operation.
                        example: c09290d0-2097-4b9b-b714-2edb394af101
                payment_method:
                  type: object
                  properties:
                    payment_option:
                      type: string
                      description: Always OPEN_INVOICE.
                      example: OPEN_INVOICE
                    transfer_type:
                      type: string
                      description: Always BANK_TRANSFER.
                      example: BANK_TRANSFER
      responses:
        '200':
          description: Success
components: {}
