Update Order Payment

Update an existing order payment.

HTTP Request

PATCH/api/orders/:id/payments/:payment_id

Authorization

Required: Yes
Permission: Staff with OrderPaymentPermission or Admin
Permission Code: 2243
Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the order to update
order_payment_id	Integer	Yes	Unique ID of the order payment to update

Request Body

Field	Type	Required	Description
payment_method	Integer	No	ID of the payment method
amount	Integer	No	Payment amount (in smallest currency unit)
approved	Boolean	No	Whether the payment is approved
transaction_id	String	No	External transaction identifier
notes	String	No	Additional notes about the payment

Example Requests

🐍 Python
🌐 Curl

1import requests
2
3# Partial update (PATCH)
4response = requests.patch('http://www.example.com/api/orders/123/payments/456', 
5  json={
6      'approved': True,
7      'transaction_id': 'TXN_UPDATED_789',
8      'notes': 'Payment approved after verification'
9  },
10  headers={'Authorization': 'Token <your_api_key>'}
11)
12print(response.json())
13
14# Update payment status only
15response = requests.patch('http://www.example.com/api/orders/123/payments/456', 
16  json={
17      'approved': False
18  },
19  headers={'Authorization': 'Token <your_api_key>'}
20)
21print(response.json())
22
23# Update amount and payment method
24response = requests.patch('http://www.example.com/api/orders/123/payments/456', 
25  json={
26      'amount': 7500,
27      'payment_method': 3
28  },
29  headers={'Authorization': 'Token <your_api_key>'}
30)
31print(response.json())

1# Partial update (PATCH)
2curl -X PATCH "http://www.example.com/api/orders/123/payments/456" -H "Authorization: Token <your_api_key>" -H "Content-Type: application/json" -d '{
3  "approved": true,
4  "transaction_id": "TXN_UPDATED_789",
5  "notes": "Payment approved after verification"
6}'
7
8# Update payment status onlyPayment
9curl -X PATCH "http://www.example.com/api/orders/123/payments/456" -H "Authorization: Token <your_api_key>" -H "Content-Type: application/json" -d '{
10  "approved": false
11}'

Response Fields

Field	Type	Description
id	Integer	Unique ID of the order
key	String	Unique key of the order (read-only)
status	String	Current status of the order
customer_data	Object	Customer information (read-only)
payment_method_data	Object	Payment method information (read-only)
shipping_method_data	Object	Shipping method information (read-only)
shipping_cost	Number	Cost of shipping
notes	String	Order notes
extra	Object	Additional order data
created_at	String (ISO 8601)	Timestamp when order was created
updated_at	String (ISO 8601)	Timestamp when order was last updated
billing_country_data	Object	Billing country information (read-only)
billing_state_data	Object	Billing state information (read-only)
billing_city_data	Object	Billing city information (read-only)
billing_address	String	Billing address
billing_postal_code	String	Billing postal code
billing_national_code	String	Billing national code
billing_mobile_number	String	Billing mobile number
billing_first_name	String	Billing first name
billing_last_name	String	Billing last name
count	Integer	Number of items in order (computed field)
quantity	Integer	Total quantity of items (computed field)
items_subtotal	Number	Subtotal of all items (computed field)
items_discount	Number	Total discount on items (computed field)
subtotal	Number	Order subtotal (computed field)
total_discount	Number	Total discount amount (computed field)
total	Number	Order total amount (computed field)
amount_paid	Number	Amount already paid (computed field)
amount_outstanding	Number	Outstanding amount (computed field)
is_paid	Boolean	Whether order is fully paid (computed field)
items	Array	List of order items (read-only)
payments	Array	List of order payments (read-only)

Customer Structure

The customer object contains:

Field	Type	Description
id	Integer	Customer ID
username	String	Customer username
mobile_number	String	Customer mobile number
first_name	String	Customer first name
last_name	String	Customer last name
full_name	String	Customer full name (computed)

Payment Method Structure

The payment_method object contains:

Field	Type	Description
id	Integer	Payment method ID
name	String	Payment method name
image	Object	Payment method image data

Shipping Method Structure

The shipping_method object contains:

Field	Type	Description
id	Integer	Shipping method ID
name	String	Shipping method name
image	Object	Shipping method image data

Image Data Structure

Field	Type	Description
id	Integer	Unique ID of the image
type	String	File type (e.g., image/jpeg)
name	String	Original file name
size	Integer	File size in bytes
human_readable_size	String	Human readable file size (e.g., 2.5 MB)
f	String	URL to access the image file
width	Integer	Image width in pixels
height	Integer	Image height in pixels
mode	String	Color mode (e.g., RGB, CMYK)
thumbnails	List of thumbnail objects	Imgae thumbnails

Thumbnail Data Structure

Field	Type	Description
id	Integer	Unique ID of the thumbnail (unique)
f	String	URL to access the thumbnail file
size	Integer	File size in bytes (nullable)

Geographic Data Structures

Country, state, and city objects contain:

Country/State:

Field	Type	Description
id	Integer	Location ID
name	String	Location name
code	String	Location code

City:

Field	Type	Description
id	Integer	City ID
name	String	City name

Order Items Structure

Each item in the items array contains:

Field	Type	Description
id	Integer	Unique ID of the order item
product	Integer	Unique ID of the product
product_name	String	Current Product Name
product_data	JsonField	Snapshot of product data at time of order
unit_price	Integer	Price per unit (in smallest currency unit)
unit_discount	Integer	Discount per unit (in smallest currency unit)
quantity	Integer	Quantity ordered
notes	String	Item-specific notes
subtotal	Integer	Calculated subtotal (computed field)
discount	Integer	Total discount for this item (computed field)
total	Integer	Final total for this item (computed field)
created_at	String (ISO 8601)	Item creation timestamp
updated_at	String (ISO 8601)	Item last update timestamp

Order Payment Structure

Each item in the payments array contains:

The shipping method structure here is the same as the above-mentioned ShippingMethod Structure.

Field	Type	Description
id	Integer	Id of the order payment
payment_method_data	Object	Payment method data of the order payment
approved	Boolean	Whether the order payment is approved
amount	Integer	The order payment amount
transaction_id	String	The transaction id of the order payment
notes	String	The extra notes about the order payment
created_at	String (ISO 8601)	The creation datetime of the order payment
updated_at	String (ISO 8601)	The last updated datetime of the order payment

Example Response

{
    "id": 2,
    "key": "0c86ab758d3e236cb5a4",
    "status": "shipped",
    "customer_data": {
        "id": 1,
        "username": "BehroozGhorbani",
        "mobile_number": "09308744204",
        "first_name": "بهروز",
        "last_name": "قربانی",
        "full_name": "بهروز قربانی"
    },
    "payment_method_data": {
        "id": 1,
        "name": "پرداخت در مخل",
        "image": null
    },
    "shipping_method_data": {
        "id": 1,
        "name": "پیک موتور",
        "image": {
            "id": 8,
            "type": "image",
            "name": "پیک موتوری",
            "size": 808754,
            "human_readable_size": "789.80 KB",
            "f": "http://127.0.0.1:8000/media/core_media/2025/12/20/Fantasticheskie_kartinki_dlja_monitora_68_63.jpg",
            "width": 1920,
            "height": 1080,
            "mode": "RGB",
            "thumbnails": [
                      {
                          "id": 213,
                          "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_64x64.jpg",
                          "size": 64
                      },
                      {
                          "id": 214,
                          "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_128x128.jpg",
                          "size": 128
                      },
                      {
                          "id": 215,
                          "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_512x512.jpg",
                          "size": 512
                      },
                      {
                          "id": 216,
                          "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_1080x1080.jpg",
                          "size": 1080
                      }
                  ]
        }
    },
    "shipping_cost": 75000,
    "notes": "Facilis sequi alias optio. Alias ipsam deserunt. At veniam nam et. Et aut id id aut quae non animi. Sed tempora aut ut ipsa dicta vel eveniet et aspernatur.",
    "extra": {
        "some": "data"
    },
    "created_at": "2025-12-27T18:17:09.771123Z",
    "updated_at": "2025-12-28T11:28:47.290350Z",
    "billing_country_data": {
        "id": 1,
        "name": "ایران",
        "code": "IR"
    },
    "billing_state_data": {
        "id": 1,
        "name": "آذربایجان شرقی",
        "code": "EA"
    },
    "billing_city_data": {
        "id": 1,
        "name": "اسکو"
    },
    "billing_address": "5411 Stokes Grove",
    "billing_postal_code": "1234567890",
    "billing_national_code": null,
    "billing_mobile_number": "09523296536",
    "billing_first_name": "پدرام",
    "billing_last_name": "زمانی",
    "count": 0,
    "quantity": 0,
    "items_subtotal": 0,
    "items_discount": 0,
    "subtotal": 0,
    "total_discount": 0,
    "total": 75000,
    "amount_paid": 500000,
    "amount_outstanding": -425000,
    "is_paid": true,
    "is_payable": true,
    "items": [],
    "payments": [
        {
            "id": 1,
            "payment_method_data": {
                "id": 1,
                "name": "پرداخت در مخل",
                "image": null
            },
            "approved": true,
            "amount": 500000,
            "transaction_id": "1589800",
            "notes": "",
            "created_at": "2025-12-28T10:43:38.509103Z",
            "updated_at": "2025-12-28T10:43:38.509107Z"
        },
        {
            "id": 2,
            "payment_method_data": {
                "id": 2,
                "name": "زرین پال",
                "image": {
                    "id": 5,
                    "type": "image",
                    "name": "keyboard",
                    "size": 2131742,
                    "human_readable_size": "2.03 MB",
                    "f": "http://127.0.0.1:8000/media/core_media/2025/11/29/Fantasticheskie_kartinki_dlja_monitora_68_96.jpg",
                    "width": 2560,
                    "height": 1600,
                    "mode": "RGB"
                }
            },
            "approved": false,
            "amount": 9800,
            "transaction_id": "12345678910111213",
            "notes": "by zarinpal",
            "created_at": "2025-12-28T13:20:31.445502Z",
            "updated_at": "2025-12-28T13:27:08.022228Z"
        }
    ]
}

HTTP Request​

Authorization​

Authorization

Path Parameters​

Request Body​

Example Requests​

Response Fields​

Customer Structure​

Payment Method Structure​

Shipping Method Structure​

Geographic Data Structures​

Order Items Structure​

Order Payment Structure​

Example Response​

HTTP Request

Authorization

Path Parameters

Request Body

Example Requests

Response Fields

Customer Structure

Payment Method Structure

Shipping Method Structure

Geographic Data Structures

Order Items Structure

Order Payment Structure

Example Response