DEFEND

Webhook payload for the DEFEND request for information.

Request
header Parameters
x-signature
string = 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorization
required
string

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Request Body schema: application/json
required
ratepay_transaction_id
string = 20 characters

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

ratepay_dispute_id
string = 20 characters

The dispute ID generated by Ratepay.

partner_transaction_id
string [ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

publication_date
string <date-time>

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

amount
number decimal places <= 2 > 0

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

currency
string[A-Z]{3}

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

type
string

Indicates the type of dispute webhook notification.

Value: "REQUEST_FOR_INFORMATION"
comment
string

Additional information about the buyer's problem description.

reason
string

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

Value: "DEFEND"
response_due_date
string <date-time>

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

Array of objects
items
Array of objects
object
Responses
200

Success

post/webhook-rfi-defend(to de defined)
Request samples
application/json
{
  • "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": [
    ],
  • "items": [
    ],
  • "payment_method": {
    }
}