Upload Invoice

Upload an invoice or other document for an existing order.

POST /pg/orders/{order_id}/documents

Upload Document

cURL

curl --request POST \
  --url https://api-staging.eximpe.com/pg/orders/{order_id}/documents/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --form identifier=IN1123213 \
  --form document_type=invoice \
  --form file='@example-file'

200

{
  "success": true,
  "message": "Documents uploaded successfully",
  "data": {
    "order_id": "OD9411897512",
    "reference_id": "TEST_FOB46D",
    "amount": 1000,
    "currency": "INR",
    "mop_type": "UPI",
    "buyer": {
      "name": "John Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "address": {
        "line_1": "123 Main Street",
        "line_2": "Apt 4B",
        "city": "City",
        "state": "State",
        "postal_code": "123456"
      },
      "pan_number": "BNYPG9212K",
      "dob": "2010-01-23"
    },
    "product": {
      "name": "Sample Product",
      "description": "This is a sample product description",
      "hs_code": "98051000",
      "hs_code_description": "Portable automatic data processing machines",
      "type_of_goods": "goods"
    },
    "invoice": {
      "number": "IN1123213",
      "date": "2025-06-22",
      "file": "https://eximpe.com/inv-12312312.pdf"
    },
    "air_waybills": [
      {
        "number": "AWB-23343",
        "file": "https://eximpe.com/awb-8F3F51D2.pdf"
      }
    ],
    "payments": [
      {
        "payment_id": "PR1469384681",
        "mop_type": "UPI",
        "status": "captured",
        "status_message": null,
        "settlement": {
          "status": "ready_for_settlement",
          "message": null,
          "settlement_details": null
        },
        "created_at": "2025-06-23T10:44:14.344135Z"
      }
    ],
    "status": "payment_successful",
    "status_message": "Payment captured successfully",
    "created_at": "2025-06-23T10:44:11.702363Z"
  }
}

Overview

The Upload Invoice endpoint is used to attach required documents to an order after it has been created. This is crucial for compliance and record-keeping. The request must be sent as multipart/form-data.

This endpoint allows you to upload a document (like an invoice or air waybill), associated with an existing order.

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

multipart/form-data

Document upload request. The body must be multipart/form-data.

identifier · string · required

Identifier for the document (e.g., order ID)

document_type · string · required

Type of document invoice or awb

file · file · required

The file to upload

Response

200

application/json

Document uploaded successfully

success · boolean · required

Indicates if the document upload was successful

message · string · required

Response message

data · object · required

Show child attributes

data. order_id · string · required

Unique order identifier

data. reference_id · string · required

Unique reference identifier for the order

data. amount · number · required

Order amount

data. currency · string · required

3-letter ISO currency code

data. status · enum<string> · required

Order status

Available options: PAYMENT_PENDING, PAYMENT_SUCCESSFUL, FAILED

data. created_at · string<date-time> · required

Order creation timestamp

data. mop_type · enum<string>

Method of payment type

Available options: UPI, CREDIT_CARD, NETBANKING, DEBIT_CARD, QR

data. buyer · object

Show child attributes

data.buyer. name · string · required

Buyer's full name

data.buyer. address · object · required

Show child attributes

data.buyer.address. line_1 · string · required

Address line 1

data.buyer.address. city · string · required

City name

data.buyer.address. state · string · required

State name

data.buyer.address. postal_code · string · required

Postal/ZIP code

data.buyer.address. line_2 · string

Address line 2

data.buyer. email · string<email>

Buyer's email address

data.buyer. phone · string

Buyer's phone number with country code

data.buyer. pan_number · string | null

Buyer's PAN number

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

Buyer's date of birth

data. product · object

Show child attributes

data.product. name · string · required

Product name

data.product. type_of_goods · enum<string> · required

Type of goods (e.g., goods)

Available options: goods, services

data.product. description · string

Product description

data.product. hs_code · string

Harmonized System code

data.product. hs_code_description · string

Description of the HS code

data. invoice · object

Show child attributes

data.invoice. number · string

Invoice number

data.invoice. date · string<date>

Invoice date in YYYY-MM-DD format

data.invoice. file · string | null

Invoice file URL

data. air_waybills · object[]

Array of air waybill information

Show child attributes

data.air_waybills. number · string

Air waybill number

data.air_waybills. file · string

Air waybill file URL

data. payments · object[]

Array of payment request information

Show child attributes

data.payments. payment_id · string · required

Payment request ID

data.payments. mop_type · enum<string> · required

Method of payment type

Available options: UPI, CREDIT_CARD, NETBANKING, DEBIT_CARD, QR

data.payments. status · enum<string> · required

Payment status

Available options: pending, captured, failed, cancelled

data.payments. created_at · string<date-time> · required

Payment request creation timestamp

data.payments. status_message · string | null

Payment status message

data.payments. settlement · object

Show child attributes

data.payments.settlement. status · enum<string>

Settlement status

Available options: pending, ready_for_settlement, settled, failed

data.payments.settlement. message · string | null

Settlement message

data.payments.settlement. settlement_details · object

Settlement details

data. status_message · string | null

Order status message

data. is_testing · boolean

Whether this is a test order