Dispute OpenAPI Specification (version)

Download OpenAPI specification:Download

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.

Provide evidence for ITEM_NOT_RECEIVED

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.

SecurityBearer Authentication
Request
path Parameters
ratepay_dispute_id
required
string = 20 characters ^[A-Za-z0-9-_]{20}$

Ratepay dispute ID

Example: OpK7rRZP0GND8MobcIKA
header Parameters
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: multipart/form-data
required
object (EvidenceWithDeliveryInformation)
additional_evidence
string <binary> (AdditionalEvidence)

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

file1
string <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.

Responses
201

Evidence was created.

404

Incorrect path parameters or invalid URL.

409

Unable to process request.

422

Unable to process request.

post/v1/disputes/{ratepay_dispute_id}/evidences/item-not-received
Request samples
curl -i -X POST \
  'https://api-integration.ratepay.com/dispute/management/v1/disputes/{ratepay_dispute_id}/evidences/item-not-received' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'evidence=[object Object]' \
  -F additional_evidence=string \
  -F file1=string
Response samples
application/json
{
  • "message": "The requested resource was not found. Please refer to the documentation for the list of resources."
}