Body
Create Payout
API is used to create a payout request with JusBiz for virtual token creation against a primary card of the corporate.
Warning
Please go through the Integration section above before starting the integration at your end and reach out to your JusBiz POC for any queries.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.biz.juspay.in/ardra/vt/provision/v2
Production Link
POST
https://{{hostname}}.biz.juspay.in/ardra/vt/provision/v2
Authorization Header
Basic Auth
*
String
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
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
Parameters
payoutId
*
string
Mandatory
Max Length :
A unique value against the token has to be created/updated. This value will also be used to fetch the token
Max length = 21
payoutId can contain alphanumeric values. It must not include special characters except _
orderAmount
*
String
Mandatory
[orderAmount + GST] is the max amount which can be redeemed from the card.
For updation: We will update the amount to new value.
Max Length = 10 digits and Decimal Upto 2 digits
gst
string
Optional
The GST amount.
payoutAmount(totalAmount) = orderAmount + gst.
Max Length = 10 digits and decimal Upto 2 digits. Payout amount should be less than equal 10 digits
action
*
string
Mandatory
This is for determining the operation.
Sample value: create | update
startDate
string
Optional
The date when the token becomes active for processing payments. If not sent, juspay will consider the currentDate as startDate for creation.
For updation: We will update the startDate to the new value
Format: YYYY-MM-DD (In UTC)
endDate
*
string
Mandatory
The date till when the token remains active for processing payments.
For updation: We will update the endDate to the new value.
Format: YYYY-MM-DD (In UTC)
currency
*
String
Mandatory
All VISA network supported currencies.
Supported currencies are mentioned under Resources.
payoutType
string
Optional
The Type of the payout. Possible values: XB
cardAlias
*
String
Mandatory
A unique alias to identify the primary/master card - juspay creates this alias during the primary card addition and is available on the dashboard for view as well as edit.
Max Length = 21 characters
rules
Json
Optional
Any Rules to be set on Virtual Card
blockPayments
List
Optional
Add a list from attached values in VISA Rules tab under Resources to block payments for a particular category.
If not passed, the payments will be allowed for all use-cases.
Default value: Null
amountRange
Json
Optional
Transaction amount range for the authorization.
If not passed, no restrictions will be applied
min
String
Optional
Min amount that can be redeemed for a transaction
If not passed, no restrictions will be applied.
Decimal Upto 2 digits. Minimum amount will be >0
max
String
Optional
Max amount that can be redeemed for a transaction
If not passed, no restrictions will be applied.
Decimal Upto 2 digits. Max amount <= total payout amount
exactAmountApply
List
Optional
List of exact amount that can be redeemed. If user tries to redeem any amount not a part of this list, it will lead to failure of txn.
Note: The number of amounts passed in this list should match with the maxAuth Provided. Currently maxAuth is by default 1.
If not passed, no restrictions will be applied.
Decimal Upto 2 digits is allowed.
mccBlock
Json Array
Optional
Ranges of MCC that are required to be blocked.
Should be passed if particular MCC ranged has to be blocked.
Upto 15 ranges are accepted.
Note: should not be passed if mccAllow is passed.
min
String
Optional
Min Range of the MCC that should be blocked.
MCC list is shared in Resources tab under VISA Rules
max
String
Optional
Max Range of the MCC that should be blocked.
MCC list is shared in Resources tab under VISA Rules
mccAllow
Json Array
Optional
Range of MCC that should be allowed for payments.
Upto 15 ranges are accepted
Note: should not be passed if mccBlock is passed
min
String
Optional
Min Range of the MCC that should be allowed.
MCC list is shared in Resources tab under VISA Rules.
max
String
Optional
Max Range of the MCC that should be allowed.
MCC list is shared in Resources tab under VISA Rules
isCardImageRequired
Boolean
Optional
To get card image pass value as True.
expenseCategoryId
*
String
Mandatory
CategoryId is to be passed to Tag a card with the expense. Expenses need to be created on the JusBiz dashboard where expenseCategoryId can be obtained. This will help you to capture enhanced data on reports.
udf1
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf2
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf3
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf4
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf5
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf6
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf7
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf8
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf9
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
udf10
String
Optional
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
200 : Success
Response Body
200 : Payout Response
Object
status
String
Status of the API call
Possible value: SUCCESS | FAILURE
Example:- SUCCESS
payoutId
String
Unique value of payout id which was sent in the request.
Example:- Juspay123456789
response
String
response body parameters
expiry
String
Contains the expiry month of the token.
state
String
Current status of the virtual token
Possible Values: ISSUED | REDEEMED | PARTIALLY_REDEEMED | EXPIRED | DELETED
payoutAmount
String
Total Amount = This is sum of orderAmount + gst
token
String
Contains the token number. Will not be available for expired and deleted tokens
currency
String
Currency of the VCC
redeemedAmount
String
Total Redeemed Amount from the VCC
cardAlias
String
userDefinedFields
String
UDF details for particular payout
udf1-10
String
Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this.
expiryMonth
String
Contains the expiry month of the token.
cardImage
String
Base 64 encoded string will be sent
cardNetwork
String
Issuing Network of the parent card
cardIssuerBankName
*
String
Mandatory
Issuing Bank of the parent card
message
String
Reason for failure / success
400 : Invalid Input data
Response Body
status
String
Key helps to identify if request is FAILURE or SUCCESS
Example:- FAILURE
message
String
Reason why the failure occurred
Example:- Invalid Expense Id Passed
payoutId
String
unique ID provided during card creation
Example:- Juspay123456789
401 : Authentication Failed
Response Body
message
String
Invalid credentials provided.
Example:- Unauthorized: Basic auth missing in headers
500 : Unexpected Error
Response Body
message
String
Database Error. Validated Expense Data cannot be Empty