Skip to main content
PATCH
Edit what a dispute's evidence shows
The new reading applies to this dispute only, even when other disputes use the same evidence. Payrails stops writing an AI reading for this evidence on this dispute.
  • Returns 409 once the defense was submitted.
  • Returns 404 when the dispute is not found or the evidence is not linked to it.

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

disputeId
string<uuid>
required

Identifier of the resource in Payrails.

evidenceId
string<uuid>
required

Identifier of the resource in Payrails.

Body

application/json
reading
string
required

What the exhibit shows. Leading and trailing spaces are removed.

Required string length: 1 - 2000
Example:

"Carrier scan: delivered to 12 Main St on 5 Sep, signed by J. Smith."

Response

The exhibit with its new reading.

The dispute's exhibit metadata for this evidence. Each dispute has its own, even when several disputes use the same evidence.

kind
enum<string>

The defense section the exhibit supports.

Available options:
transaction,
proof-of-delivery,
customer-communication,
merchant-policy,
cancellation,
cardholder-authentication,
product-as-described
source
string

Where the exhibit came from: library, upload, payrails_payments, or push: followed by the pushed record type.

reading
string

What the exhibit shows, as the issuer reads it next to the file.

Maximum string length: 2000
writtenBy
enum<string>

Who wrote the current reading.

Available options:
ai,
user
updatedAt
string<date-time>

When the reading last changed.