--- page_title: Token Status Check product: Jusbiz - Payouts page_source: https://juspay.io/in/docs/jusbiz/docs/integration/token-status-check openapi: https://juspay.io/in/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Fin%2Fdocs%2Fjusbiz%2Fdocs%2Fintegration%2Ftoken-status-check llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/jusbiz/llms.txt --- ## API Version: default # Token Status Check API is used to fetch the current status of payout created.Possible values for the order status.## Endpoints: - Sandbox: https://sandbox.biz.juspay.in/ardra/vt/fetchStatus/v2 - Production: https://{{hostname}}.biz.juspay.in/ardra/vt/fetchStatus/v2 ## Request Type: POST ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string - Value: Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: String, Mandatory ## Headers: #### X-merchantid: Pass merchant-id provided by Juspay - Tags: string, Mandatory #### KeyId: Key Id against which encryption is done (to be taken from JusBiz Dashboard) - Tags: String, Mandatory #### Content-Type: - Value: application/json - Tags: String, Mandatory ## Sample Code Snippets: ### Sample Request: #### Request Code Snippet: ```request curl --location 'https://sandbox.biz.juspay.in/ardra/vt/fetchStatus/v2' \ --header 'KeyId: ' \ --header 'X-merchantid: ' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic MktCUUJaVVJMQkU3WVVHUjo=' \ --data '{ "payoutId" : "Juspay123456789" }' ``` ### Sample Response: #### Response: ```json { "status": "SUCCESS", "response": { "authRemaining": 0, "settlementDetails": [ { "transactionReferenceNumber": "VT241100337000160000007", "transactionDateTime": "2024-04-24T00:00:00", "supplierName": "VAYUDOOT HOLIDAYS", "billingAmount": "20.00", "sourceCurrencyCode": "INR", "transactionTypeDetail": "Purchase", "supplierISOCurrencyCode": "IND", "sourceAmount": "20.00", "transactionTypeCode": "Debit", "billingCurrencyCode": "INR" }, { "transactionReferenceNumber": "VT241190347000090000062", "transactionDateTime": "2024-04-27T00:00:00", "supplierName": "VAYUDOOT HOLIDAYS", "billingAmount": "20.00", "sourceCurrencyCode": "INR", "transactionTypeDetail": "Payment", "supplierISOCurrencyCode": "IND", "sourceAmount": "20.00", "transactionTypeCode": "Credit", "billingCurrencyCode": "INR" } ], "expiry": "09/2025", "state": "REDEEMED", "orderAmount": "20.0", "payoutAmount": "20.0", "authList": [ { "tranTime": "2024-04-24T04:07:52", "merchantCategoryCode": "7011", "tranAmount": 20.00, "merchantCity": "DELHI", "tranStatus": "AuthorizationSuccess", "supplierName": "VAYUDOOT HOLIDAYS", "tranCurrency": "INR", "tranId": "394115148722473", "merchantCountry": "IND", "errorMessage": "Do not honor" }, { "tranTime": "2024-04-21T08:10:59", "merchantCategoryCode": "7011", "tranAmount": 25.00, "merchantCity": "DELHI", "tranStatus": "AuthorizationFailure", "supplierName": "VAYUDOOT HOLIDAYS", "tranCurrency": "INR", "tranId": "394112294591405", "merchantCountry": "IND", "errorMessage": "Spend Velocity restriction" } ], "rules": { "mccAllow": null, "mccBlock": [ { "max": "7000", "min": "6000" }, { "max": "9000", "min": "8000" }, ], "blockPayments": [ "ATM","ECOM" ], "amountRange": { "max": "21", "min": "3" }, "exactAmountApply": [ "1" ] }, "authPerformed": 1, "endDate": "2024-09-25", "token": "4817XXXXXXXX8569", "cardLastFourDigits": "0602", "startDate": "2024-04-23", "currency": "INR", "cardNetwork": "VISA", "balanceAmount": "0.0", "gst": "0.0", "redeemedAmount": "20.0", "cardIssuerBankName": "IndusInd", "userDefinedFields": { "udf1": "XYZ", "udf2": "XYZ", "udf3": "XYZ", "udf4": "XYZ", "udf5": "XYZ" } }, "message": "Virtual Token Fetched Successfully", "payoutId": "Juspay123456789" } ``` ## Body Parameters: ### Section1: #### payoutId: - Description: A unique value against the token required to fetch the latest status of the virtual token - Value: value - Tags: String, Mandatory ## API Responses: ### 200: #### 200: Response Body: - Description: Status of the API callPossible value: SUCCESS | FAILURE - Tags: Object #### payoutId: - Description: Unique value of payout id which was sent in the request. - Tags: String #### message: - Description: Reason for failure / success. - Tags: String #### response: - Description: The response contains the details around the token which will be used for processing payments - Value: - **Token**: - Description: Contains the token number. Will not be available for expired and deleted tokens. - Tags: String - **Expiry**: - Description: Contains the expiry month of the token. Will not be available for expired and deleted tokens. - Tags: String - **StartDate**: - Description: Contains the startDate on which token becomes active for processing payments. - Value: - **UpdatedAt**: - Description: Timestamp at which transaction details were udpated - Tags: String - **TransactionRef**: - Description: Reference ID assigned by Juspay for attempting the transaction - Tags: String - **Status**: - Description: Current status of transaction created by the order - Tags: String - **FulfillmentMethod**: - Description: Combination of Gateway and Rail via which transaction is being attempted - Tags: String - **CreatedAt**: - Description: Timestamp at which transaction was created at Juspay end - Tags: String - **Amount**: - Description: Amount of payout being attempted - Tags: String - Tags: Object - **EndDate**: - Description: Contains the endDate till when the token remains active. - Tags: String - **State**: - Description: Current state of the token Possible Values: ISSUED | REDEEMED | PARTIALLY_REDEEMED | EXPIRED | DELETED - Tags: String - **PayoutAmount**: - Description: Total Amount = This is sum of orderAmount + gst - Tags: String - **OrderAmount**: - Description: Order Amount - Tags: String - **Gst**: - Description: GST amount - Tags: String - **Currency**: - Description: Currency of the payout - Tags: Array Of Strings - **RedeemedAmount**: - Description: Total Redeemed Amount from the VCC - Tags: String - **AuthPerformed**: - Description: Number of times successful auth is performed - Tags: String - **CardLastFourDigits**: - Description: Actual Card’s Last four digit - Tags: String - **CardAlias**: - Description: A unique alias to identify the card - juspay creates this alias during the funding pan addition and will be avaliable on the JusBiz Dashboard - Tags: String - **CardNetwork**: - Description: Issuing Network of the parent card - Tags: String - **CardIssuerBankName**: - Description: Issuing Bank of the parent card - Tags: String - **Transactions**: - Description: List of txn auth details received for particular token number - Value: - **RqstType**: - Description: Denotes whether authorization was successful or failure AUTHORIZATION_SUCCESS | AUTHORIZATION_FAILURE - Tags: String - **TranId**: - Description: Unique transaction ID assigned to transaction - Tags: String - **AuthTime**: - Description: DateTime on which transaction was made at point of sale,Format: timestamp is in UTC - Tags: String - **TranAmnt**: - Description: Amount that was sent for payment authorization - Tags: String - **TranCurrCd**: - Description: Currency code in which the card was redeemed - Tags: String - **MerchCatgCd**: - Description: Merchant category code of the beneficiary who redeemed the Virtual Card - Tags: String - **MrchCity**: - Description: City of the beneficiary who redeemed the Virtual Card - Tags: String - **MrchName**: - Description: Name of the beneficiary who redeemed the Virtual Card - Tags: String - **ErrMsg**: - Description: Error message in case transaction was unsuccessful - Tags: String - Tags: Json, Conditional - **SettlementDetails**: - Description: List of settled trxns for particular token number **Note** : Will be available post settlement data is received from Bank/Network - Value: - **TransactionReferenceNumber**: - Description: Reference number of the transaction made **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **TransactionDateTime**: - Description: DateTime on which transaction was made at point of sale (Format: UTC) **Note** : 1. We are only receiving ‘Date’ in the settlement file and ‘Time’ field is empty. 2. Will be available post settlement data is received from Bank/Network - Tags: String - **SupplierName**: - Description: Name of Supplier to which the transaction was made **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **SupplierISOCurrencyCode**: - Description: Currency Code of Supplier to which the transaction was made **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **BillingAmount**: - Description: Amount that is billed to the Cardholder. **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **BillingCurrencyCode**: - Description: Currency in which transaction amount is billed. **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **TransactionTypeCode**: - Description: Denotes whether txn is Debit or Credit **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **SourceAmount**: - Description: Supplier Source Amount of a transaction. **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - **SourceCurrencyCode**: - Description: Currency of the Source Amount in which the transaction was made. **Note** : Will be available post settlement data is received from Bank/Network - Tags: String - Tags: Json, Conditional - **Rules**: - Description: List of rules configured on VCC - Value: exactAm ountApply - Tags: Json, Mandatory - **UserDefinedFields**: - Description: UDF details for particular payout - Value: - **Udf1-10**: - Description: Optional Fields - Any unique IDs which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String - Tags: Json, Conditional - Tags: Object --- ## See Also - [Create Payout](https://juspay.io/in/docs/jusbiz/docs/integration/create-payout) - [Get Security Code](https://juspay.io/in/docs/jusbiz/docs/integration/get-security-code)