Update Dispute Order

Authorization

apiKey

x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Path Parameters

disputeId*string

The Chargeflow dispute id

Match^[0-9a-fA-F]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderReference?string

A field that can hold the name of the order as identified in your system, which could be an invoice ID or any other reference

Lengthlength <= 10000

creationDate?string

The date and time when the order was created, recorded in ISO 8601 format

Formatdate-time

checkoutId?string

An optional identifier for the checkout process associated with the order

Lengthlength <= 10000

orderStatusUrl?string

An optional URL that directs to a page where the status of the order can be reviewed

Formaturi

amount?

financialStatus?string

An enum value represents the current financial status of the order. Possible values include paid, partially_refunded, and refunded, which indicate the payment stage of the order

Value in

"paid"
"partially_refunded"
"refunded"

customer?

An object that represents the customer’s details under this order

billingAddress?

An object that represents the billing address of the order's payer

shippingAddress?

An object that represents the shipping address of the order's payer

products?array<>

An array of objects that represent the products included in this order

transactions?array<>

An array of objects that represent the transactions related to this order

shipments?array<>

An array of objects that represent the shipments related to shipments this order

subscriptions?array<>

An array of objects that represent the subscriptions related to this order

pastOrders?array<>

An array of objects that represent the past orders related to this order

Response Body

`application/json`

curl -X POST "https://example.com/public/2024-03-18/disputes/string/order" \  -H "Content-Type: application/json" \  -d '{}'

{  "requestId": "string"}