Sign in

v1

latestOpenAPI 3.0.12026-08-068054.3 KB

DEFEND

Webhook payload for the DEFEND request for information.

post/webhook-rfi-defend(to de defined)

Request body

ratepay_transaction_idstring

The identifier for the transaction provided by Ratepay in the response to the authorization request.

ratepay_dispute_idstring

The dispute ID generated by Ratepay.

partner_transaction_idstring

The identifier for the transaction generated by the partner.

publication_datestring date-time

Date and time of publication of the request for information. Format in accordance with ISO 8601.

amountnumber

The amount of the request for information, as requested by the buyer.

currencystring

The currency of all amounts pertaining to the transaction. Upper-case alphabetic code in accordance with ISO 4217.

type'REQUEST_FOR_INFORMATION'

Indicates the type of dispute webhook notification.

commentstring

Additional information about the buyer's problem description.

reason'DEFEND'

The reason of a REQUEST_FOR_INFORMATION may be DEFEND, ITEM_NOT_RECEIVED, FRAUD or ITEM_RETURNED.

response_due_datestring date-time

Date and time by which the evidence for the case can be provided. Format in accordance with ISO 8601.

itemsobject[]

Example request

{
  "ratepay_transaction_id": "2vqgHujqswxwqa7Ms9Q1",
  "ratepay_dispute_id": "6vqgHujqswxwqa7Ms9Q1",
  "partner_transaction_id": "partner-transaction-id-1234",
  "publication_date": "2021-02-19T15:00:00.05+00:00",
  "amount": 529.9,
  "currency": "EUR",
  "type": "REQUEST_FOR_INFORMATION",
  "comment": "Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde retourniert.",
  "reason": "DEFEND",
  "response_due_date": "2021-03-11T00:00:00.12+00:00",
  "captures": [
    {
      "date": "2021-02-03T19:09:00.12+00:00",
      "partner_operation_id": "7816171225883407",
      "ratepay_payment_reference": "GE7671626N4",
      "ratepay_capture_id": "c09290d0-2097-4b9b-b714-2edb394af101"
    }
  ],
  "payment_method": {
    "payment_option": "OPEN_INVOICE",
    "transfer_type": "BANK_TRANSFER"
  }
}

Response

Success