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

Statusstring

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

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

ChangeDatedate-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 [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Chargeback

object

required

Idstringrequired

DisputeCreatedDatedate-timerequired

DueDatedate-timerequired

InstallmentPlanNumberstringrequired

InstallmentNumberint64required

PlanStatusstringrequired

TransactionIdstringrequired

MerchantNamestringrequired

TotalPlanAmount

object

required

Amountnumberrequired

CurrencyCodestringrequired

DisputeAmount

object

required

Amountnumberrequired

CurrencyCodestringrequired

StatusDisputeStatus (string)required

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

PlanActivatedDatedate-time

ReasonCodestringrequired

Evidences

object[]

required

Array [

EvidenceIdstringrequired

UploadedAtdate-timerequired

FileNamestringrequired

FileTypestringrequired

]

Comments

object[]

required

Array [

CommentIdstringrequired

Textstringrequired

CommentAtdate-timerequired

]

Example (from schema)

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

401

Response Headers

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

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

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

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

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

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

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

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