Skip to main content
PATCH
/
pg
/
orders
/
{order_id}
Update Order
curl --request PATCH \
  --url https://api-pacb-uat.eximpe.com/pg/orders/{order_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "buyer": {
    "pan_number": "CDEFG1234H",
    "dob": "1992-08-14"
  },
  "invoice": {
    "number": "INV_UPDATED_2024_1205",
    "date": "2024-12-05"
  }
}
'
{
  "success": true,
  "message": "Order updated successfully",
  "data": {
    "success": true,
    "message": "Order updated successfully",
    "data": {
      "order_id": "{Order_ID}",
      "buyer": {
        "pan_number": "CDEFG1234H",
        "dob": "1992-08-14"
      },
      "invoice": {
        "number": "INV_UPDATED_2024_1205",
        "date": "2024-12-05"
      }
    }
  }
}

​
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 updating order details after creation or if additional buyer information is requested from the bank. You can update the following fields:
  • Buyer Information: PAN number, date of birth
  • Invoice Information: Invoice number, invoice date

​
Request Parameters

​
Path

NameInTypeRequiredDescription
order_idpathstringYesUnique identifier of the order

​
Body (JSON)

Only include the fields you want to update.

​
Parameter Definitions

​
Top-level

NameTypeRequiredDescriptionConstraints
buyerobjectNoBuyer information to updateSee Buyer object
invoiceobjectNoInvoice information to updateSee Invoice object

​
Buyer

NameTypeRequiredDescriptionConstraints
pan_numberstringNoBuyer’s PAN numberFormat: Indian PAN (e.g., ABCDE1234F)
dobstring (date)NoBuyer’s date of birthFormat: YYYY-MM-DD

​
Invoice

NameTypeRequiredDescriptionConstraints
numberstringNoInvoice numberMax 255 chars
datestring (date)NoInvoice dateFormat: YYYY-MM-DD

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X' or '2.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

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

​
invoice
object

Invoice information to update

Response

Order updated successfully

​
success
boolean
required

Indicates if the request was successful

​
message
string
required

Response message

​
data
object
required

Nested response data