JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Update Order

Update an order that has already been created. The only amount, address and UDF fields can be updated. Address fields can be optionally sent as explained in the /orders API.
The API response is similar to that of the order create API.

Update order is not recommended once the transaction is initiated to PG. Updating the order amount might lead to order amount mismatch (In case there are retry allowed on same order id).

Request

Response

API Endpoints

Sandbox Link

POST

https://api.sandbox.juspay.io/orders/{order_id}

Production Link

POST

https://api.juspay.io/orders/{order_id}

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      
                      

string

application/x-www-form-urlencoded

                      x-merchantid
                      *
                      

string

Required

The merchant_id/username that you hold at Juspay

                      order_id
                      *
                      

String

Mandatory

Order Id of the order for which you want to update

Example:- JPAYNEW035

Body

                      amount
                      *
                      

Double

Required

New amount value

                      billing_address_first_name
                      
                      

String

                      billing_address_last_name
                      
                      

String

                      billing_address_line1
                      
                      

String

                      billing_address_line2
                      
                      

String

                      billing_address_line3
                      
                      

String

                      billing_address_city
                      
                      

String

                      billing_address_state
                      
                      

String

                      billing_address_country
                      
                      

String

                      billing_address_postal_code
                      
                      

String

                      billing_address_phone
                      
                      

String

                      billing_address_country_code_iso
                      
                      

String

                      shipping_address_first_name
                      
                      

String

                      shipping_address_last_name
                      
                      

String

                      shipping_address_line1
                      
                      

String

                      shipping_address_line2
                      
                      

String

                      shipping_address_line3
                      
                      

String

                      shipping_address_city
                      
                      

String

                      shipping_address_state
                      
                      

String

                      shipping_address_country
                      
                      

String

                      shipping_address_postal_code
                      
                      

String

                      shipping_address_phone
                      
                      

String

                      shipping_address_country_code_iso
                      
                      

String

                      udf1
                      
                      

String

                      udf2
                      
                      

String

                      udf3
                      
                      

String

                      udf4
                      
                      

String

                      udf5
                      
                      

String

                      udf6
                      
                      

String

                      udf7
                      
                      

String

                      udf8
                      
                      

String

                      udf9
                      
                      

String

                      udf10
                      
                      

String

Response Body

                      customer_email
                      *
                      

string

Required

The email Id of the customer provided during order creation

                      customer_phone
                      *
                      

string

Required

The phone number of the customer provided during order creation

                      customer_id
                      *
                      

string

Required

The customer id provided during order creation

                      status_id
                      *
                      

integer

Required

Status ID is a numeric id corresponding to the status value.

                      status
                      *
                      

string

Required

Status of the order. For information on different order status and handling, refer

id

string

Unique ID generated by JusPay for the given order

                      merchant_id
                      
                      

string

The merchant id provided by Juspay

                      amount
                      
                      

integer

The order amount

                      currency
                      
                      

string

The currency provided during order creation.

                      order_id
                      
                      

string

OrderId provided in the request

                      date_created
                      
                      

string

Timestamp indicating when the order was created.

                      return_url
                      
                      

string

The return url provided during order creation

                      product_id
                      
                      

string

The product_id provided during order creation

                      payment_links
                      
                      

object

Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order.

                      iframe
                      
                      

string

web

string

                      mobile
                      
                      

string

                      udf1
                      
                      

string