Dispute

A card transaction dispute: submit, list, get or withdraw one, or upload a file for it.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

disputes, err := client.Dispute(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(disputes)
dispute, err := client.Dispute(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(dispute)
created, err := client.Dispute(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.Dispute(nil).Update(map[string]any{"id": "example_id", "profile_id": 1, "status": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

Construct client as shown in the Lua setup, then call the operations:

local disputes, err = client:Dispute():list({ profile_id = 1 })
local dispute, err = client:Dispute():load({ id = "example_id", profile_id = 1 })
local created, err = client:Dispute():create({ profile_id = 1 })
local updated, err = client:Dispute():update({ id = "example_id", profile_id = 1, status = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$disputes = $client->Dispute()->list(["profile_id" => 1]);
$dispute = $client->Dispute()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->Dispute()->create(["profile_id" => 1]);
$updated = $client->Dispute()->update(["id" => "example_id", "profile_id" => 1, "status" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

disputes = client.Dispute().list({"profile_id": 1})
dispute = client.Dispute().load({"id": "example_id", "profile_id": 1})
created = client.Dispute().create({ "profile_id": 1 })
updated = client.Dispute().update({"id": "example_id", "profile_id": 1, "status": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

disputes = client.Dispute.list({ "profile_id" => 1 })
dispute = client.Dispute.load({ "id" => "example_id", "profile_id" => 1 })
created = client.Dispute.create({ "profile_id" => 1 })
updated = client.Dispute.update({ "id" => "example_id", "profile_id" => 1, "status" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const disputes = await client.Dispute().list({ profile_id: 1 })
const dispute = await client.Dispute().load({ id: "example_id", profile_id: 1 })
const created = await client.Dispute().create({ profile_id: 1 })
const updated = await client.Dispute().update({ id: "example_id", profile_id: 1, status: "example" })

Fields

create

POST /spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}

Operation ID: disputeSubmit.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

{
  "disclaimer": {
    "allAnswered": true,
    "filesUploaded": true
  },
  "form": {
    "agreedDetails": {
      "agreed": true,
      "agreedReason": "some reason"
    },
    "charged": {
      "currency": "EUR",
      "value": 50
    },
    "details": "wrong amount dispute",
    "expected": {
      "currency": "EUR",
      "value": 5
    },
    "goods": "something"
  },
  "transaction": {
    "email": "support@partner.com",
    "transactionId": "12345"
  }
}

Responses

200: Dynamic Flow JSON response. If using the Dynamic Flow framework, pass this to the framework. If using the API directly, the response can be ignored.

application/json

The response is object.

Example response:

{
  "actions": [
    {
      "$id": "continue",
      "exit": true,
      "title": "Continue"
    }
  ],
  "key": "final",
  "layout": [
    {
      "components": [
        {
          "type": "image",
          "url": "https://wise.com/web-art/assets/illustrations/email-success-large%402x.png"
        }
      ],
      "type": "box",
      "width": "md"
    },
    {
      "align": "center",
      "margin": "lg",
      "markdown": "Thanks for reporting this transaction. It's pre-authorised right now, but as soon as it becomes \"spent\" we'll begin our investigation.",
      "type": "info"
    },
    {
      "action": {
        "$ref": "continue",
        "x-ref": "continue"
      },
      "type": "button"
    }
  ],
  "schemas": [],
  "title": "Done!",
  "type": "form"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /spend/profiles/{profileId}/dispute-form/file

Operation ID: disputeFileUpload.

Authentication: bearer token (UserToken).

Parameters

Request body

multipart/form-data

Responses

200: A key-value pair mapping the file name to the assigned file ID

application/json

The response is object.

Example response:

{
  "receipt": "ab4f5d2"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /spend/profiles/{profileId}/disputes

Operation ID: disputeList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Paginated list of disputes

application/json

Example response:

{
  "disputes": [
    {
      "canWithdraw": true,
      "createdAt": "2024-03-08T08:30:14.989Z",
      "createdBy": "6097861",
      "id": "51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb",
      "lastUpdatedAt": "2024-03-08T08:30:14.989Z",
      "profileId": 16605997,
      "reason": "NEVER_ARRIVED",
      "status": "ACTIVE",
      "statusMessage": "Submitted",
      "subStatus": "SUBMITTED",
      "transactionId": 2040
    },
    {
      "canWithdraw": true,
      "createdAt": "2024-03-27T02:24:16.878Z",
      "createdBy": "6097861",
      "id": "9c5ca0cb-00d6-41f7-8214-8cfdb11388a7",
      "lastUpdatedAt": "2024-03-27T02:24:16.878Z",
      "profileId": 16605997,
      "reason": "CANCELLED_ORDER",
      "status": "ACTIVE",
      "statusMessage": "Submitted",
      "subStatus": "SUBMITTED",
      "transactionId": 3405
    }
  ],
  "totalCount": 2
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /spend/profiles/{profileId}/disputes/{disputeId}

Operation ID: disputeGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: The dispute

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PUT /spend/profiles/{profileId}/disputes/{disputeId}/status

Operation ID: disputeWithdraw.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

{
  "status": "CLOSED"
}

Responses

200: The updated dispute

application/json

Example response:

{
  "canWithdraw": false,
  "createdAt": "2024-03-08T08:30:14.989Z",
  "createdBy": "6097861",
  "id": "51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb",
  "lastUpdatedAt": "2024-03-27T13:12:28.390Z",
  "profileId": 16605997,
  "reason": "NEVER_ARRIVED",
  "status": "CLOSED",
  "statusMessage": "Withdrawn",
  "subStatus": "WITHDRAWN",
  "transactionId": 2040
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.