Skip to content
Developer
/Webhooks/
/
DEFEND

Dispute Webhooks OpenAPI Specification (version)

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.

Download OpenAPI description
dispute_webhooks.json
dispute_webhooks.yaml
Overview
URL

https://www.ratepay.com/

Ratepay

info@ratepay.com

Languages
Servers

https://docs.ratepay.com/

ITEM_NOT_RECEIVED

Request

Webhook payload for the ITEM_NOT_RECEIVED request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "2vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
commentstring

Additional information about the buyer's problem description.

Example: "Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde retourniert."
reasonstring

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

Value"ITEM_NOT_RECEIVED"
Example: "ITEM_NOT_RECEIVED"
response_due_datestring(date-time)

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

Example: "2021-03-11T00:00:00.12+00:00"
capturesArray of objects
itemsArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "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": "ITEM_NOT_RECEIVED",
    "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"
      }
    ],
    "items": [
      {}
    ],
    "payment_method": {
      "payment_option": "OPEN_INVOICE",
      "transfer_type": "BANK_TRANSFER"
    }
  }'

Responses

Success

Outcome for ITEM_NOT_RECEIVED

Request

Outcome webhook payload for the ITEM_NOT_RECEIVED request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "2vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
reasonstring

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

Value"ITEM_NOT_RECEIVED"
Example: "ITEM_NOT_RECEIVED"
resolution_datestring(date-time)

Date and time when the resolution webhook was created. Format in accordance with ISO 8601.

Example: "2021-04-17T00:00:00.12+00:00"
resolution_reasonstring

The resolution reason may be CLOSED, CHARGEBACK or FRAUD.

Example: "CLOSED"
capturesArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-outcome(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "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",
    "reason": "ITEM_NOT_RECEIVED",
    "resolution_date": "2021-04-17T00:00:00.12+00:00",
    "resolution_reason": "CLOSED",
    "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"
    }
  }'

Responses

Success

ITEM_RETURNED

Request

Webhook payload for the ITEM_RETURNED request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "2vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
commentstring

Additional information about the buyer's problem description.

Example: "Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde retourniert."
reasonstring

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

Value"ITEM_RETURNED"
Example: "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.

Example: "2021-03-11T00:00:00.12+00:00"
capturesArray of objects
tracking_codeArray of objects
itemsArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-return(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "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": "ITEM_RETURNED",
    "response_due_date": "2021-03-11T00:00:00.12+00:00",
    "captures": [
      {
        "date": "2021-02-03T19:09:00.12+02:00",
        "partner_operation_id": "7816171225883407",
        "ratepay_payment_reference": "GE7671626N4",
        "ratepay_capture_id": "c09290d0-2097-4b9b-b714-2edb394af101"
      }
    ],
    "tracking_code": [
      {
        "carrier_name": "DHL",
        "tracking_number": "JJD0099999999"
      }
    ],
    "items": [
      {}
    ],
    "payment_method": {
      "payment_option": "OPEN_INVOICE",
      "transfer_type": "BANK_TRANSFER"
    }
  }'

Responses

Success

Outcome for ITEM_RETURNED

Request

Outcome webhook payload for the ITEM_RETURNED request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "7vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
reasonstring

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

Value"ITEM_RETURNED"
Example: "ITEM_RETURNED"
resolution_datestring(date-time)

Date and time when the resolution webhook was created. Format in accordance with ISO 8601.

Example: "2021-04-17T00:00:00.12+00:00"
resolution_reasonstring

The resolution reason may be CLOSED or CHARGEBACK.

Example: "CLOSED"
capturesArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-return-outcome(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "ratepay_transaction_id": "7vqgHujqswxwqa7Ms9Q1",
    "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",
    "reason": "ITEM_RETURNED",
    "resolution_date": "2021-04-17T00:00:00.12+00:00",
    "resolution_reason": "CLOSED",
    "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"
    }
  }'

Responses

Success

DEFEND

Request

Webhook payload for the DEFEND request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "2vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
commentstring

Additional information about the buyer's problem description.

Example: "Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde retourniert."
reasonstring

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

Value"DEFEND"
Example: "DEFEND"
response_due_datestring(date-time)

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

Example: "2021-03-11T00:00:00.12+00:00"
capturesArray of objects
itemsArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-defend(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "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"
      }
    ],
    "items": [
      {}
    ],
    "payment_method": {
      "payment_option": "OPEN_INVOICE",
      "transfer_type": "BANK_TRANSFER"
    }
  }'

Responses

Success

Outcome for DEFEND

Request

Outcome webhook payload for the DEFEND request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "7vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
reasonstring

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

Value"DEFEND"
Example: "DEFEND"
resolution_datestring(date-time)

Date and time when the resolution webhook was created. Format conforming to ISO 8601.

Example: "2021-04-17T00:00:00.12+00:00"
resolution_reasonstring

The resolution reason may be CLOSED or CHARGEBACK.

Example: "CLOSED"
capturesArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-defend-outcome(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "ratepay_transaction_id": "7vqgHujqswxwqa7Ms9Q1",
    "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",
    "reason": "DEFEND",
    "resolution_date": "2021-04-17T00:00:00.12+00:00",
    "resolution_reason": "CLOSED",
    "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"
    }
  }'

Responses

Success

FRAUD

Request

Webhook payload for the FRAUD request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "2vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
commentstring

Additional information about the buyer's problem description.

Example: "Artikel wurde nicht vom Empfänger bestellt. Lieferung wurde retourniert."
reasonstring

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

Value"FRAUD"
Example: "FRAUD"
response_due_datestring(date-time)

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

Example: "2021-03-11T00:00:00.12+00:00"
capturesArray of objects
tracking_codeArray of objects
itemsArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-fraud(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "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": "FRAUD",
    "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"
      }
    ],
    "tracking_code": [
      {
        "carrier_name": "DHL",
        "tracking_number": "JJD0099999999"
      }
    ],
    "items": [
      {}
    ],
    "payment_method": {
      "payment_option": "OPEN_INVOICE",
      "transfer_type": "BANK_TRANSFER"
    }
  }'

Responses

Success

Outcome for FRAUD

Request

Outcome webhook payload for the FRAUD request for information.

Headers
x-signaturestring= 128 characters

The hashed (SHA-512) payload.

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
ratepay_transaction_idstring= 20 characters

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

Example: "7vqgHujqswxwqa7Ms9Q1"
ratepay_dispute_idstring= 20 characters

The dispute ID generated by Ratepay.

Example: "6vqgHujqswxwqa7Ms9Q1"
partner_transaction_idstring[ 1 .. 50 ] characters

The identifier for the transaction generated by the partner.

Example: "partner-transaction-id-1234"
publication_datestring(date-time)

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

Example: "2021-02-19T15:00:00.05+00:00"
amountnumberdecimal places <= 2> 0

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

Example: 529.9
currencystring[A-Z]{3}

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

Example: "EUR"
typestring

Indicates the type of dispute webhook notification.

Value"REQUEST_FOR_INFORMATION"
Example: "REQUEST_FOR_INFORMATION"
reasonstring

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

Value"FRAUD"
Example: "FRAUD"
resolution_datestring(date-time)

Date and time when the resolution webhook was created. Format in accordance with ISO 8601.

Example: "2021-04-17T00:00:00.12+00:00"
resolution_reasonstring

The resolution reason is always CLOSED.

Example: "CLOSED"
capturesArray of objects
payment_methodobject
curl -i -X POST \
  'https://docs.ratepay.com/webhook-rfi-fraud-outcome(to%20de%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "ratepay_transaction_id": "7vqgHujqswxwqa7Ms9Q1",
    "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",
    "reason": "FRAUD",
    "resolution_date": "2021-04-17T00:00:00.12+00:00",
    "resolution_reason": "CLOSED",
    "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"
    }
  }'

Responses

Success