Order Status
API is used to fetch the current status of payout created. Possible values for the order status
|
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
|
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Pass merchant-id provided by Juspay
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
fulfillment, payment, refund based on requirement.
Timestamp at which order details were updated
Order level user defined fields passed in order create by the merchant
Current status of the order
Order ID passed by merchant in create order request
Timestamp at which fulfillment details were updated
Fulfillment level user defined fields passed by merchant
Timestamp at which transaction details were udpated
Reference ID assigned by Juspay for attempting the transaction
Current status of transaction created by the order
Combination of Gateway and Rail via which transaction is being attempted
Timestamp at which transaction was created at Juspay end
Amount of payout being attempted
ifsc of the payee bank.
response recieved from the gateway
response message proivded by Juspay
response code proivded by Juspay
Decription of the failure reason/error code
Txn_id generated by the gateway for a particualr txn
UTR/RRN provided by the gateway
Timestamp at which fulfillment order status was last updated
Current status of the fulfillment
Preferred gateways passed by merchant in create order request
Customer ID passed by merchant in create order request
Fulfillment ID created by Juspay for the order
Gateways selected to attempt the fulfillment on. This will be combination of preferredMethodList and priority logic
Timestamp at which fulfillment was created
Beneficiary details passed by merchant in create order request
Type of payout
Example:- ACCOUNT_IFSC | UPI_ID | PAYOUT_LINK | BENE_ID | WALLET
Beneficiary details submitted by the end customer for payout_link type
Example:- ACC_IFSC | VPA
ifsc of the customer’s bank
account number of the customer’s bank
UPI_ID/VPA of the customer
beneficiary name passed in order create request
Short length payout_link url
Long length payout_link url
expiry time of the payout_link
beneficiary mobile number passed in order create request
Note: This field is optional and should not be used to drive any internal logic.
Fulfillment amount passed by the merchant
Additional information included by merchant in create order request
PaymentPage corresponding client-id
status history of the payout_link lifecycle
webhook endpoint url passed by merchant in order create request
url to which the webhook notifications should be sent for the particular order
ex: Payout Transaction
payout_link status for submitting beneficiary details
Example:- FULFILL_ONLY
Total amount of the order
customer_id passed by the merchant
Have questions?
- Need help? Contact support
- LLM? Read llms.txt