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

Token Status Check

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

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.biz.juspay.in/ardra/vt/fetchStatus/v2

Production Link

POST

https://{{hostname}}.biz.juspay.in/ardra/vt/fetchStatus/v2

                      Basic Auth
                      *
                      

String

Mandatory

Consists of two parts.

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

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      X-merchantid
                      *
                      

string

Mandatory

Pass merchant-id provided by Juspay

                      KeyId
                      *
                      

String

Mandatory

Key Id against which encryption is done (to be taken from JusBiz Dashboard)

                      Content-Type
                      *
                      

String

Mandatory

Example:- application/json

Body

                      payoutId
                      *
                      

String

Mandatory

A unique value against the token required to fetch the latest status of the virtual token

Response Body

                      200: Response Body
                      
                      

Object

Status of the API call
Possible value: SUCCESS | FAILURE

                      payoutId
                      
                      

String

Unique value of payout id which was sent in the request.

                      message
                      
                      

String

Reason for failure / success.

                      response
                      
                      

Object

The response contains the details around the token which will be used for processing payments

                      token
                      
                      

String

Contains the token number. Will not be available for expired and deleted tokens.

                      expiry
                      
                      

String

Contains the expiry month of the token. Will not be available for expired and deleted tokens.

                      startDate
                      
                      

Object

Contains the startDate on which token becomes active for processing payments.

                      updatedAt
                      
                      

String

Timestamp at which transaction details were udpated

                      transactionRef
                      
                      

String

Reference ID assigned by Juspay for attempting the transaction

                      status
                      
                      

String

Current status of transaction created by the order

                      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

                      endDate
                      
                      

String

Contains the endDate till when the token remains active.

                      state
                      
                      

String

Current state of the token

Possible Values: ISSUED | REDEEMED | PARTIALLY_REDEEMED | EXPIRED | DELETED

                      payoutAmount
                      
                      

String

Total Amount = This is sum of orderAmount + gst

                      orderAmount
                      
                      

String

Order Amount

gst

String

GST amount

                      currency
                      
                      

Array Of Strings

Currency of the payout

                      redeemedAmount
                      
                      

String

Total Redeemed Amount from the VCC

                      authPerformed
                      
                      

String

Number of times successful auth is performed

                      cardLastFourDigits
                      
                      

String

Actual Card’s Last four digit

                      cardAlias
                      
                      

String

A unique alias to identify the card - juspay creates this alias during the funding pan addition and will be avaliable on the JusBiz Dashboard

                      cardNetwork
                      
                      

String

Issuing Network of the parent card

                      cardIssuerBankName
                      
                      

String

Issuing Bank of the parent card

                      transactions
                      
                      

Json

Conditional

List of txn auth details received for particular token number

                      rqstType
                      
                      

String

Denotes whether authorization was successful or failure

AUTHORIZATION_SUCCESS | AUTHORIZATION_FAILURE

                      tranId
                      
                      

String

Unique transaction ID assigned to transaction

                      authTime
                      
                      

String

DateTime on which transaction was made at point of sale,
Format: timestamp is in UTC

                      tranAmnt
                      
                      

String

Amount that was sent for payment authorization

                      tranCurrCd
                      
                      

String

Currency code in which the card was redeemed

                      merchCatgCd
                      
                      

String

Merchant category code of the beneficiary who redeemed the Virtual Card

                      mrchCity
                      
                      

String

City of the beneficiary who redeemed the Virtual Card

                      mrchName
                      
                      

String

Name of the beneficiary who redeemed the Virtual Card

                      errMsg
                      
                      

String

Error message in case transaction was unsuccessful

                      settlementDetails
                      
                      

Json

Conditional

List of settled trxns for particular token number

Note: Will be available post settlement data is received from Bank/Network

                      transactionReferenceNumber
                      
                      

String

Reference number of the transaction made

Note: Will be available post settlement data is received from Bank/Network

                      transactionDateTime
                      
                      

String

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

                      supplierName
                      
                      

String

Name of Supplier to which the transaction was made

Note: Will be available post settlement data is received from Bank/Network

                      supplierISOCurrencyCode
                      
                      

String

Currency Code of Supplier to which the transaction was made

Note: Will be available post settlement data is received from Bank/Network

                      billingAmount
                      
                      

String

Amount that is billed to the Cardholder.

Note: Will be available post settlement data is received from Bank/Network

                      billingCurrencyCode
                      
                      

String

Currency in which transaction amount is billed.

Note: Will be available post settlement data is received from Bank/Network

                      transactionTypeCode
                      
                      

String

Denotes whether txn is Debit or Credit

Note: Will be available post settlement data is received from Bank/Network

                      sourceAmount
                      
                      

String

Supplier Source Amount of a transaction.

Note: Will be available post settlement data is received from Bank/Network

                      sourceCurrencyCode
                      
                      

String

Currency of the Source Amount in which the transaction was made.

Note: Will be available post settlement data is received from Bank/Network

                      rules
                      *
                      

Json

Mandatory

List of rules configured on VCC

exactAm ountApply

                      userDefinedFields
                      
                      

Json

Conditional

UDF details for particular payout

                      udf1-10
                      
                      

String

Optional Fields - Any unique IDs which is required for searching on the Frontend Dashboard to be sent in this.