Update Order

Update specific fields of an existing order.

PATCH /pg/orders/{order_id}

Try it

Update Order

cURL

curl --request PATCH \
  --url https://api-staging.eximpe.com/pg/orders/{order_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "buyer": {
    "pan_number": "BNYPG9212K",
    "dob": "2010-01-23"
  },
  "invoice": {
    "number": "INV_2TIO9F",
    "date": "2025-06-22"
  }
}
'

200

{
  "success": true,
  "message": "Order updated successfully",
  "data": {
    "success": true,
    "message": "Order updated successfully",
    "data": {
      "order_id": "{Order_ID}",
      "buyer": {
        "pan_number": "BNYPG9212K",
        "dob": "2010-01-23"
      },
      "invoice": {
        "number": "INV_2TIO9F",
        "date": "2025-06-22"
      }
    }
  }
}

Overview

The Update Order endpoint enables you to modify specific information of an existing order, such as buyer details (PAN number, date of birth) and invoice information. This is useful for correcting or updating order details after creation.

You can update the following fields:

• Buyer Information: PAN number, date of birth
• Invoice Information: Invoice number, invoice date

Authorizations

X-Client-ID · string · header · required

Client app ID. You can find your app id in the merchant dashboard.

X-Client-Secret · string · header · required

Client secret key. You can find your secret in the merchant dashboard.

Path Parameters

order_id · string · required

Unique identifier of the order

Body

application/json

Order update request - only include fields to update

Request body for updating order - only include fields to update

buyer · object

Buyer information to update

Show child attributes

buyer. pan_number · string

Buyer's PAN number

buyer. dob · string<date>

Buyer's date of birth (YYYY-MM-DD)

invoice · object

Invoice information to update

Show child attributes

invoice. number · string

Invoice number

invoice. date · string<date>

Invoice date (YYYY-MM-DD)

Response

200

application/json

Order updated successfully

success · boolean · required

Indicates if the request was successful

message · string · required

Response message

data · object · required

Nested response data

Show child attributes

data. success · boolean

Indicates if the order update was successful

data. message · string

Success message for the order update

data. data · object

Contains the updated order fields

Show child attributes

data.data. order_id · string

The ID of the updated order

data.data. buyer · object

Updated buyer information

Show child attributes

data.data.buyer. pan_number · string

Updated PAN number

data.data.buyer. dob · string<date>

Updated date of birth

data.data. invoice · object

Updated invoice information

Show child attributes

data.data.invoice. number · string

Updated invoice number

data.data.invoice. date · string<date>

Updated invoice date