Update dispute evidence

Updates dispute evidence by ID.

Read our disputes guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.write scope.

PATCH
/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}
cURL Go Java PHP Python TypeScript
1
2
3
4
5
6
curl -X PATCH "https://api.moov.io/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}" \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "text": "string",
    "evidenceType": "receipt"
  }'\
1
2
3
4
5
6
7
8
9
mc, _ := moov.NewClient()

var accountID string
var disputeID string
var evidenceID string

mc.UpdateDisputeEvidence(ctx, accountID, disputeID, evidenceID, moov.DisputesEvidenceUpdate{
  EvidenceType: moov.EvidenceType_Receipt,
})
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.components.UpdateEvidence;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UpdateDisputeEvidenceRequest;
import io.moov.sdk.models.operations.UpdateDisputeEvidenceResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        UpdateDisputeEvidenceRequest req = UpdateDisputeEvidenceRequest.builder()
                .accountID("f19d220a-55c9-476d-9cfa-d9a536b8065f")
                .disputeID("da248348-9f0d-4df8-a9c6-66cc2492e87a")
                .evidenceID("a204faa9-3cce-4628-b833-5b0694ac47bb")
                .updateEvidence(UpdateEvidence.builder()
                    .build())
                .build();

        UpdateDisputeEvidenceResponse res = sdk.disputes().updateEvidence()
                .request(req)
                .call();

        if (res.disputeEvidenceResponse().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\UpdateDisputeEvidenceRequest(
    accountID: 'f19d220a-55c9-476d-9cfa-d9a536b8065f',
    disputeID: 'da248348-9f0d-4df8-a9c6-66cc2492e87a',
    evidenceID: 'a204faa9-3cce-4628-b833-5b0694ac47bb',
    updateEvidence: new Components\UpdateEvidence(),
);

$response = $sdk->disputes->updateEvidence(
    request: $request
);

if ($response->disputeEvidenceResponse !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.disputes.update_evidence(account_id="f19d220a-55c9-476d-9cfa-d9a536b8065f", dispute_id="da248348-9f0d-4df8-a9c6-66cc2492e87a", evidence_id="a204faa9-3cce-4628-b833-5b0694ac47bb")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.disputes.updateEvidence({
    accountID: "f19d220a-55c9-476d-9cfa-d9a536b8065f",
    disputeID: "da248348-9f0d-4df8-a9c6-66cc2492e87a",
    evidenceID: "a204faa9-3cce-4628-b833-5b0694ac47bb",
    updateEvidence: {},
  });

  // Handle the result
  console.log(result);
}

run();
200 400 401 403 404 429 500 504
The request completed successfully.
{
  "properties": {
    "createdOn": {
      "format": "date-time",
      "type": "string"
    },
    "disputeID": {
      "format": "uuid",
      "type": "string"
    },
    "evidenceID": {
      "format": "uuid",
      "type": "string"
    },
    "evidenceType": {
      "enum": [
        "receipt",
        "proof-of-delivery",
        "cancelation-policy",
        "terms-of-service",
        "customer-communication",
        "generic-evidence",
        "cover-letter",
        "other"
      ],
      "type": "string"
    },
    "filename": {
      "description": "For file evidence, the name of the file.",
      "type": "string"
    },
    "mimeType": {
      "description": "For file evidence, the MIME type of the file.",
      "type": "string"
    },
    "size": {
      "description": "For file evidence, the size of the file.",
      "format": "int64",
      "type": "integer"
    },
    "submittedOn": {
      "description": "When the evidence was submitted for review.",
      "format": "date-time",
      "type": "string"
    },
    "text": {
      "description": "For text evidence, the text submitted as evidence.",
      "type": "string"
    },
    "updatedOn": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "evidenceID",
    "disputeID",
    "evidenceType",
    "createdOn",
    "updatedOn"
  ],
  "type": "object"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

disputeID

string <uuid> required

evidenceID

string <uuid> required

Body

application/json

evidenceType

string<enum>
Possible values: receipt, proof-of-delivery, cancelation-policy, terms-of-service, customer-communication, generic-evidence, cover-letter, other

text

string
If updating text evidence, the new text to associate with the dispute.

Response

application/json

createdOn

string<date-time> required

disputeID

string<uuid> required

evidenceID

string<uuid> required

evidenceType

string<enum> required
Possible values: receipt, proof-of-delivery, cancelation-policy, terms-of-service, customer-communication, generic-evidence, cover-letter, other

updatedOn

string<date-time> required

filename

string
For file evidence, the name of the file.

mimeType

string
For file evidence, the MIME type of the file.

size

integer<int64>
For file evidence, the size of the file.

submittedOn

string<date-time>
When the evidence was submitted for review.

text

string
For text evidence, the text submitted as evidence.