Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Order Status

Get order status is an API call to fetch the latest status for a particular payout request placed, based on the Query parameter: expand = fulfillment, payment or refund

NOTE:
The response shown for this API only shows the result for expand = fulfillment. Possible (tentative) response parameters for expand = payment or expand = refund are shown in tables below.
The response for this API (with expand = fulfillment) returns an updated fulfillments array with Transactions and Beneficiary details.
(click to open table)
ParameterTypeDescription
orderIdStringUnique Reference for the order. This will be the ID for any subsequent communications.
amountStringTotal order amount, which is the sum of all the fulfilment amounts
customerIdwwwwwwwwwwwStringUnique ID for the customer generated by the merchant.
createdAtStringDate/time (ISO representation) when order was created
updatedAt:StringDate/time (ISO representation) of the most recent update
typeString"FULFILL_ONLY".
statusString"FULFILLMENTS_SUCCESSFUL" unless otherwise indicated:
  Status codes and meaning
CREATED
Pending
    Order Created
READY_FOR_FULFILLMENT
Pending
    Payment Received and can be added to scheduler
FULFILLMENTS_SCHEDULED
Pending
    Task added to scheduler but not yet picked up
FULFILLMENTS_FAILURE
Failure
    All Fulfillment attempts are Failed
FULFILLMENTS_SUCCESSFUL
Success
    Fulfillment completed successfully
FULFILLMENTS_MANUAL_REVIEW
Check with bank
    Any one of the Fulfillments is in MANUAL_REVIEW
fulfillments: [[{...},{...},...]Array of
Objects
Status of fulfillment related items with details of transactions and Account/Card/Wallet/VPA details of each beneficiary.
Parameters for each fulfillments object in array:
ParameterTypeDescription
updatedBy:wwwwwwwwwwString"DEFAULT" unless otherwise indicated
updatedAtStringDate/time (ISO representation) of the fulfillment update
typeString"ORDER"
idStringUnique ID generated by Juspay for the fulfillment order.
createdAtStringDate/time (ISO representation) when fulfillment order was created
statusString"SUCCESS" unless otherwise indicated:
  Status codes and meaning
SUCCESS
    This means that the fulfillment has been successfully
    executed.
PENDING
    This would mean that the fulfillment has been queued with
    JusPay or with the downstream system.
FAILURE
    We were unable to process the fulfillment successfully.
    You have to try again with a new unique_request_id.
MANUAL_REVIEW
    This would mean that the fulfillment request was sent an
    ambigious response from the payment gateway and the
    merchant has to manually reconcile it with the payment
    gateway to get the proper response. Also, any
    fulfillment which are in pending for more than
    10 days are sent for manual review.
statusUpdatedAtStringDate/time (ISO representation) of fulfillment status update
merchantCustomerIdStringUnique ID generated by Juspay for the merchant.
preferredMethodList:wwt
    [string1, string2,..]
Array of
Strings
This will define the list of methods to be used for fulfillments for instance - [“YESBANK_IMPS”,”CASHFREE_IMPS”]
fulfillmentMethodList:
    [string1, string2,..]
Array of
Strings
The actual methods that were used for the fulfillment
amountStringAmount to be processed for the particular fulfillment, which is the sum of all transaction amounts for the fulfillment. Sum of all the fulfilment amounts should be equal to the total order amount.
transactions: [[{...},{...},...]Array of
objects
Array containing details of each transaction in the fulfillment order
  Parameters for each transactions object in array:
updatedAtStringDate/time (ISO representation) of transaction update
transactionRefStringUnique ID assigned to the transaction request (same as requestId in txnResponse object below).
timeStampStringDate/time (ISO representation) of transaction
statusString"SUCCESS" unless otherwise indicated:
  Status codes and meaning
SUCCESS
    This means that the transactions have been successfully
    executed.
PENDING
    This would mean that a transaction has been queued with
    JusPay or with the downstream system.
FAILURE
    We were unable to process the transaction successfully.
    You have to try again with a new unique_request_id.
MANUAL_REVIEW
    This would mean that the transaction request was sent an
    ambigious response from the payment gateway and the
    merchant has to manually reconcile it with the payment
    gateway to get the proper response. Also, any transactions
    which are in pending for more than 10 days are sent for
    manual review.
gatewayRefIdStringReference ID for the gateway used
fulfillmentMethodStringThe actual method that was used for transaction fulfillment - for instance: “YESBANK_IMPS” or ”CASHFREE_IMPS”.
createdAtStringDate/time (ISO representation) when transaction order was created
amountdoubleAmount to be processed for the particular transaction. Sum of all the fulfillment's transaction amounts should be equal to the total amount for the fulfillment.
txnResponse:wwwwwww
   {param1, param2,..}
JSON
object
This object will contain a summary and status of the transaction
Parameters for each txnResponse object:
statusString"SUCCESS" unless otherwise indicated (see table above).
requestIdStringUnique ID assigned to the transaction request (same as transactionRef in transactions object).
amountDoubleAmount to be processed for the particular transaction. Sum of all the fulfillment's transaction amounts should be equal to the total amount for the fulfillment.
beneficiaryDetails:wwwnw
      {param, object}
JSON
object
These objects contain Account/Card/Wallet/VPA details of each beneficiary in which the payout is to be processed.
  Parameters for each beneficiaryDetails object:
typeStringCARD for card transfer, UPI_ID for transfer to vpa, ACCOUNT_IFSC for transfer to account, and WALLET for transfer to Paytm Wallet
details:wwwwwwwwwwn
   {param1, param2,..}
JSON
object
This object will contain the Account/Card/Wallet/VPA details
Parameters for each details object:
nameStringName of beneficiary
accountStringAccount of beneficiary (Required for transfer to account)
ifscStringIFSC of beneficiary (Required for transfer to account)
cardReferenceStringCardReference to the card details stored in Juspay Card Vault(Required for card transfer)
bankCodeStringIIN of the card issuer - a list of bankCode & bankNames is provided (Required for card transfer)
brandStringCard brand - “VISA/MASTERCARD/AMEX…” (Required for card transfer) Wallet brand - "PAYTM" (Required for wallet transfer)
cardTypeString“CREDIT” / "DEBIT" (Required for card transfer)
vpaStringUPI id of beneficiary (Required for transfer to vpa)
walletIdentifierStringNumber with which user has registered Paytm Wallet.
  A possible response for expand = payment       (click to view)
FieldTypeDescription
orderIdStringUnique Reference for the order. This will be the ID for any subsequent communications.
amountStringTotal order amount, which is the sum of all the payment amounts
customerIdwwwwwwwwiStringUnique ID for the customer generated by the merchant.
createdAtStringDate/time (ISO representation) when order was created
updatedAt:StringDate/time (ISO representation) of the most recent update
typeString"PAYMENTS_ONLY".
statusString"PAYMENTS_SUCCESSFUL" unless otherwise indicated:
  Status codes and meaning
CREATED
Pending
    Order Created
READY_FOR_PAYMENTS
Pending
    Payments Received and can be added to scheduler
PAYMENTS_SCHEDULED
Pending
    Task added to scheduler but not yet picked up
PAYMENTS_FAILURE
Failure
    All Payment attempts are Failed
PAYMENTS_SUCCESSFUL
Success
    Payments completed successfully
PAYMENTS_MANUAL_REVIEW
Check with bank
    Any one of the Payments is in MANUAL_REVIEW
payments: [{...},{....}...]Array of
objects
This array contains a series of payment instrument details
(Parameters in object are listed in table below - click to open)
  Parameters for each payments object in array:
FieldTypeDescription
payment_method_typeStringPayment method type used when creating the mandate. Must be either CARD, NB, WALLET, or UPI.
payment_methodStringPayment method used when creating the mandate. Found in the given tables for the corresponding Payment API and transaction type.
updatedBy:wwwwwwwwwwString"DEFAULT" unless otherwise indicated
updatedAtStringDate/time (ISO representation) of the payment update
typeString"PAYMENT"
idStringUnique ID generated by Juspay for the payment order.
createdAtStringDate/time (ISO representation) when payment order was created
statusString"SUCCESS" unless otherwise indicated:
  Status codes and meaning
SUCCESS
    This means that the payment has been successfully
    executed.
PENDING
    This would mean that a payment has been queued with
    JusPay or with the downstream system.
FAILURE
    We were unable to process the payment successfully.
    You have to try again with a new unique_request_id.
MANUAL_REVIEW
    This would mean that the payment request was sent an
    ambigious response from the payment gateway and the
    merchant has to manually reconcile it with the payment
    gateway to get the proper response. Also, any
    payments which are in pending for more than
    10 days are sent for manual review.
statusUpdatedAtStringDate/time (ISO representation) of payment status update
merchantCustomerIdStringUnique ID generated by Juspay for the merchant.
amountStringAmount to be processed for the particular payment. Sum of all the payment amounts should be equal to the total payment amount.
auth-typeStringType of authentication used.
upi_details:wwwwwwnwww
      {payer_vpa}
Object
String
UPI details related to customer.
Payer VPA used during order creation.
    UPI Details Object Parameter:
FieldTypeDescription
payer_vpaStringPayer VPA used during order creation.
wallet_details:
    {brand, walletIdentifier}
Object
String
Wallet details of customer.wwnww
    Wallet Details Object Parameter:
FieldTypeDescription
brandString"PAYTM" (Required for wallet transfer)
walletIdentifierStringNumber with which user has registered Paytm Wallet.
card details:
    {param1, param2,...}
Object
String
Card details.wwwwtwwwwww
    Card Details Object Parameters:
FieldTypeDescription
using_saved_cardBooleanTrue if using a saved card
saved_to_lockerBooleanTrue if card has been saved to locker
last_four_digitsStringLast four digits of card number
name_on_cardStringCard holder name. Should contain alphabetical characters only.
expiry_yearStringExpiry year of the card (Format: "yyyy")
expiry_monthStringExpiry month of the card (Format: "mm")
card_typeString"CREDIT" or "DEBIT"
card_issuerStringCode for bank that issued the card
(Example: "HDFC Bank")
card_isinStringInternational Securities Identification Number for card    (Example: "545721")
card_brandStringBrand of card ("MASTERCARD", "VISA", etc.)
bank_details:
      {param1, param2,...}
Object
String
Bank detailswwwwwnwwwwwn
    Bank Details Object Parameters:
FieldTypeDescription
objectString"bank_account"
idStringBank account ID generated by Juspay
customer_idStringCustomer ID sent in request. (Customer ID is provided by juspay or is the object reference ID given by merchant during customer creation.)
date_createdStringDate that account was created
bank_nameString**Name of bank
account_numberStringBank account number
beneficiary_nameStringName of the customer in a given bank account
ifscStringIFSC code for a bank branch
validation_amountStringAmount that account is validated for
currencyStringType of currency
validation_statusStringStatus of account (CREATED, PENDING, or ACTIVE)
last_validatedStringTime/date of most recent validation
metadata:
   {param1, param2, ....}
StringCustom key-value sets sent in previous request
NOTE:
Only those parameters in bold may be necessary for the Bank Details Object.
  A possible response for expand = refund       (click to view)
FieldTypeDescription
orderIdStringUnique Reference for the order. This will be the ID for any subsequent communications.
amountStringTotal refund amount, which is the sum of all the individual refund amounts
customerIdwwwwwwwStringUnique ID for the customer generated by the merchant.
createdAtStringDate/time (ISO representation) when order was created
updatedAt:StringDate/time (ISO representation) of the most recent update
typeString"REFUNDS_ONLY".
statusString"REFUNDS_SUCCESSFUL" unless otherwise indicated:
  Status codes and meaning
CREATED
Pending
    Order Created
READY_FOR_REFUNDS
Pending
    Refund Orders Received and can be added to scheduler
REFUNDS_SCHEDULED
Pending
    Task added to scheduler but not yet picked up
REFUNDS_FAILURE
Failure
    All Refund attempts have Failed
REFUNDS_SUCCESSFUL
Success
    Refunds completed successfully
REFUNDS_MANUAL_REVIEW
Check with bank
    Any one of the Refund orders is in MANUAL_REVIEW
Refunds: [{...},{...},..]Array
wwwwt
An array of Refund Objects with details of each refund.
  Refunds Object Parameters:
FieldTypeDescription
unique_request_idStringUnique ID generated for the request
refStringReference number provided by the bank for the refund
idStringUnique ID generated by Juspay for the refund order.
typeString"REFUND"
amountStringTotal amount to be processed for the particular refund. Sum of all the refund amounts should be equal to the total refund amount.
updatedBy:wwwwwwwwwwString"DEFAULT" unless otherwise indicated
createdAtStringDate time (ISO representation) when refund was created
updatedAtStringDate/time (ISO representation) of the refund update
statusUpdatedAtStringDate/time (ISO representation) of refund status update
statusString"SUCCESS" unless otherwise indicated:
  Status codes and meaning
SUCCESS
    This means that the refund has been successfully
    executed.
PENDING
    This would mean that the refund has been queued with
    JusPay or with the downstream system.
FAILURE
    We were unable to process the refund successfully.
    You have to try again with a new unique_request_id.
MANUAL_REVIEW
    This would mean that the refund request was sent an
    ambigious response from the payment gateway and the
    merchant has to manually reconcile it with the payment
    gateway to get the proper response. Also, any
    refunds which are in pending for more than
    10 days are sent for manual review.
merchantCustomerIdStringUnique ID generated by Juspay for the merchant.
error_messageStringMessage if error occured
sent_to_gatewayBooleanSet to 'true' if request was sent to gateway
The request for the Order Status API consists of one Path parameter:   orderId,  one optional Query parameter:  expand, and two Headers.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!