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

Order Status

API is used to fetch the current status of payout created. Possible values for the order status

Scroll inside to view more

Status	Details	Action
READY_FOR_FULFILLMENT	Request received by Juspay	Pending
FULFILLMENTS_SCHEDULED	Task added to scheduler and will be picked up	Pending
FULFILLMENTS_FAILURE	All transaction attempts have failed	Failure
FULFILLMENTS_SUCCESSFUL	Fulfillment completed successfully	Success
FULFILLMENTS_CANCELLED	Fulfillment cancelled by merchant from Dashboard	Failure
FULFILLMENTS_MANUAL_REVIEW	Any one of the Fulfillment is in MANUAL_REVIEW	To be reviewed with bank

Request

Response

API Endpoints

Sandbox Link

GET

https://api.sandbox.juspay.io/payout/merchant/v1/orders/:orderId?expand=fulfillment,payment,refund

Production Link

GET

https://api.juspay.io/payout/merchant/v1/orders/:orderId?expand=fulfillment,payment,refund

                      Basic Auth
                      *
                      

String

Mandatory

Consists of two parts.

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

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Pass merchant-id provided by Juspay

                      Content-Type
                      
                      

String

application/json

                      expand
                      
                      

string

fulfillment, payment, refund based on requirement.

Response Body

                      200: Response Body
                      
                      

Object

                      updatedAt
                      
                      

String

Timestamp at which order details were updated

                      udf1-5
                      
                      

String

Order level user defined fields passed in order create by the merchant

                      status
                      
                      

String

Current status of the order

                      orderId
                      
                      

String

Order ID passed by merchant in create order request

                      fulfillments
                      
                      

Object

                      updatedAt
                      
                      

String

Timestamp at which fulfillment details were updated

                      udf1-5
                      
                      

String

Fulfillment level user defined fields passed by merchant

                      transactions
                      
                      

Object

                      updatedAt
                      
                      

String

Timestamp at which transaction details were udpated

                      transactionRef
                      
                      

String

Reference ID assigned by Juspay for attempting the transaction

                      status
                      
                      

String

                      fulfillmentMethod
                      
                      

String

Combination of Gateway and Rail via which transaction is being attempted

                      createdAt
                      
                      

String

Timestamp at which transaction was created at Juspay end

                      amount
                      
                      

String

Amount of payout being attempted

                      responseMessage
                      
                      

String

Response message from Gateway

                      responseCode
                      
                      

String

Response Code from Gateway

                      responseDescription
                      
                      

String

Response description

                      epgTxnId
                      
                      

String

Gateway id from PG

                      statusUpdatedAt
                      
                      

String

Timestamp at which fulfillment order status was last updated

                      status
                      
                      

String

                      preferredMethodList
                      
                      

Array of Strings

Preferred gateways passed by merchant in create order request

                      merchantCustomerId
                      
                      

String

Customer ID passed by merchant in create order request

id

String

Fulfillment ID created by Juspay for the order

                      fulfillmentMethodList
                      
                      

Array Of Strings

Gateways selected to attempt the fulfillment on. This will be combination of preferredMethodList and priority logic

                      createdAt
                      
                      

String

Timestamp at which fulfillment was created

                      beneficiaryDetails
                      
                      

String

Beneficiary details passed by merchant in create order request

                      type
                      
                      

String

Payout type passed in create order request

                      amount
                      
                      

String

Fulfillment amount passed by the merchant

                      additionalInfo
                      
                      

String

Additional information included by merchant in create order request