Update Chargeback Status

PUT 
/api/chargebacks/:id/status

Change the status of a chargeback upon receiving notification from your provider (your account must have the proper permissions to call this endpoint).

Request

Path Parameters

id stringrequired

Dispute id

application/json

Body

required

Status string

Possible values: [Open, Won, Lost, Closed, Other, Pending]

The new status you'd like to change to. If the current status is Open, you can only change it to Won or Lost. If the current status is Won or Lost, you can only change it to Closed

ChangeDate date-time

The date the status was changed. Optional, so if not included in the request, will be set to now (if included, should be a time that is less than or equal to now). Should be in UTC format, e.g. "2024-04-29T14:33:44.613Z"

Responses

200

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Code string

Message string

AdditionalInfo string

]

StatusCode int32required
TraceId string
IsSuccess booleanrequired

Chargeback

object

required

Id stringrequired

DisputeCreatedDate date-timerequired

DueDate date-timerequired

InstallmentPlanNumber stringrequired

InstallmentNumber int64required

PlanStatus stringrequired

TransactionId stringrequired

MerchantName stringrequired

TotalPlanAmount

object

required

Amount numberrequired

CurrencyCode stringrequired

DisputeAmount

object

required

Amount numberrequired

CurrencyCode stringrequired

Status DisputeStatus (string)required

Possible values: [Open, Won, Lost, Closed, Other, Pending]

PlanActivatedDate date-time

ReasonCode stringrequired

Evidences

object[]

required

Array [

EvidenceId stringrequired

UploadedAt date-timerequired

FileName stringrequired

FileType stringrequired

]

Comments

object[]

required

Array [

CommentId stringrequired

Text stringrequired

CommentAt date-timerequired

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "Chargeback": {
    "Id": "string",
    "DisputeCreatedDate": "2024-06-06T16:41:09.410Z",
    "DueDate": "2024-06-06T16:41:09.410Z",
    "InstallmentPlanNumber": "string",
    "InstallmentNumber": 0,
    "PlanStatus": "string",
    "TransactionId": "string",
    "MerchantName": "string",
    "TotalPlanAmount": {
      "Amount": 0,
      "CurrencyCode": "string"
    },
    "DisputeAmount": {
      "Amount": 0,
      "CurrencyCode": "string"
    },
    "Status": "Open",
    "PlanActivatedDate": "2024-06-06T16:41:09.411Z",
    "ReasonCode": "string",
    "Evidences": [
      {
        "EvidenceId": "string",
        "UploadedAt": "2024-06-06T16:41:09.411Z",
        "FileName": "string",
        "FileType": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": "string",
        "Text": "string",
        "CommentAt": "2024-06-06T16:41:09.411Z"
      }
    ]
  }
}

401

Response Headers

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

403

Response Headers

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

404

Response Headers

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

500

Response Headers

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

Loading...