Skip to content

Dispute OpenAPI Specification (version)

This is the documentation for the Ratepay Dispute API. The API is still in development and subject to change. This documentation will evolve as the development of the API progresses.

Download OpenAPI description
dispute_api.json
dispute_api.yaml
Overview
URL

https://www.ratepay.com/

Ratepay

info@ratepay.com

Languages
Servers
Ratepay Integration Platform

https://api-integration.ratepay.com/dispute/management/

Provide evidence for ITEM_NOT_RECEIVED

Request

Endpoint to provide evidence for the ITEM_NOT_RECEIVED request for information.

A valid JWT token is required in order to perform requests against this API. See Ratepay Authentication API specification.

Security
Bearer Authentication
Path
ratepay_dispute_idstring= 20 characters^[A-Za-z0-9-_]{20}$required

Ratepay dispute ID

Example: OpK7rRZP0GND8MobcIKA
Headers
Authorizationstringrequired

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

Bodymultipart/form-datarequired
evidenceobject(EvidenceWithDeliveryInformation)required
additional_evidencestring(binary)(AdditionalEvidence)

File with additional evidence. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

file1string(binary)(NoteFile)

Information about the items included in the shipment. Key name must correspond to the actual value of the evidence field. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

curl -i -X POST \
  https://api-integration.ratepay.com/dispute/management/v1/disputes/OpK7rRZP0GND8MobcIKA/evidences/item-not-received \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'evidence[ratepay_transaction_id]=scwBgARW-nE93I7_ywhp' \
  -F 'evidence[delivery_information][0][carrier_name]=DHL' \
  -F 'evidence[delivery_information][0][tracking_number]=2.3834745636235124e+23' \
  -F 'evidence[delivery_information][0][status]=PENDING' \
  -F 'evidence[delivery_information][0][date]=2019-05-17' \
  -F 'evidence[delivery_information][0][address]=Alpenstrasse 21, 15432 DE' \
  -F 'evidence[delivery_information][0][note]=string' \
  -F additional_evidence=string \
  -F file1=string

Responses

Evidence was created.

Response
No content

Provide evidence for ITEM_RETURNED

Request

Endpoint to provide evidence for the ITEM_RETURNED request for information.

A valid JWT token is required in order to perform requests against this API. See Ratepay Authentication API specification.

Security
Bearer Authentication
Path
ratepay_dispute_idstring= 20 characters^[A-Za-z0-9-_]{20}$required

Ratepay dispute ID

Example: OpK7rRZP0GND8MobcIKA
Headers
Authorizationstringrequired

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

Bodymultipart/form-datarequired
evidenceobject(EvidenceWithCaseDetails)required
additional_evidencestring(binary)(AdditionalEvidence)

File with additional evidence. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

curl -i -X POST \
  https://api-integration.ratepay.com/dispute/management/v1/disputes/OpK7rRZP0GND8MobcIKA/evidences/item-returned \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'evidence[ratepay_transaction_id]=scwBgARW-nE93I7_ywhp' \
  -F 'evidence[case_details]=Information regarding the case xyz' \
  -F additional_evidence=string

Responses

Evidence was created.

Response
No content

Provide evidence for DEFEND

Request

Endpoint to provide evidence for the DEFEND request for information.

A valid JWT token is required in order to perform requests against this API. See Ratepay Authentication API specification.

Security
Bearer Authentication
Path
ratepay_dispute_idstring= 20 characters^[A-Za-z0-9-_]{20}$required

Ratepay dispute ID

Example: OpK7rRZP0GND8MobcIKA
Headers
Authorizationstringrequired

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

Bodymultipart/form-datarequired
evidenceobject(EvidenceWithDeliveryInformation)required
additional_evidencestring(binary)(AdditionalEvidence)

File with additional evidence. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

file1string(binary)(NoteFile)

Information about the items included in the shipment. Key name must correspond to the actual value of the evidence field. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

curl -i -X POST \
  https://api-integration.ratepay.com/dispute/management/v1/disputes/OpK7rRZP0GND8MobcIKA/evidences/defend \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'evidence[ratepay_transaction_id]=scwBgARW-nE93I7_ywhp' \
  -F 'evidence[delivery_information][0][carrier_name]=DHL' \
  -F 'evidence[delivery_information][0][tracking_number]=2.3834745636235124e+23' \
  -F 'evidence[delivery_information][0][status]=PENDING' \
  -F 'evidence[delivery_information][0][date]=2019-05-17' \
  -F 'evidence[delivery_information][0][address]=Alpenstrasse 21, 15432 DE' \
  -F 'evidence[delivery_information][0][note]=string' \
  -F additional_evidence=string \
  -F file1=string

Responses

Evidence was created.

Response
No content

Provide evidence for FRAUD

Request

Endpoint to provide evidence for the FRAUD request for information.

A valid JWT token is required in order to perform requests against this API. See Ratepay Authentication API specification.

Security
Bearer Authentication
Path
ratepay_dispute_idstring= 20 characters^[A-Za-z0-9-_]{20}$required

Ratepay dispute ID

Example: OpK7rRZP0GND8MobcIKA
Headers
Authorizationstringrequired

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

Bodymultipart/form-datarequired
evidenceobject(FullEvidence)required
additional_evidencestring(binary)
file1string(binary)(NoteFile)

Information about the items included in the shipment. Key name must correspond to the actual value of the evidence field. Allowed types are '.zip', '.pdf', '.jpg', '.png', '.gif', '.txt'. Maximum file size is 10 MB.

curl -i -X POST \
  https://api-integration.ratepay.com/dispute/management/v1/disputes/OpK7rRZP0GND8MobcIKA/evidences/fraud \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'evidence[ratepay_transaction_id]=scwBgARW-nE93I7_ywhp' \
  -F 'evidence[case_details]=Information regarding the case xyz' \
  -F 'evidence[delivery_information][0][carrier_name]=DHL' \
  -F 'evidence[delivery_information][0][tracking_number]=2.3834745636235124e+23' \
  -F 'evidence[delivery_information][0][status]=PENDING' \
  -F 'evidence[delivery_information][0][date]=2019-05-17' \
  -F 'evidence[delivery_information][0][address]=Alpenstrasse 21, 15432 DE' \
  -F 'evidence[delivery_information][0][note]=string' \
  -F additional_evidence=string \
  -F file1=string

Responses

Evidence was created.

Response
No content