--- page_source: https://docs.juspay.io/jusbiz/docs/integration/create-payout page_title: Create Payout --- ## API Version: default # 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. ## Endpoints: - Sandbox: https://sandbox.biz.juspay.in/ardra/vt/provision/v2 - Production: https://{{hostname}}.biz.juspay.in/ardra/vt/provision/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 {"success":false,"message":"No Data found for the given path"} ``` ### Sample Response: #### Response: ```json {"success":false,"message":"No Data found for the given path"} ``` ## Body Parameters: ### Parameters: #### payoutId: - Description: 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 _ - Tags: string, Mandatory, Max Length : #### orderAmount: - Description: [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 - Tags: String, Mandatory #### gst: - Description: 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 - Tags: string, Optional #### action: - Description: This is for determining the operation. Sample value: create | update - Tags: string, Mandatory #### startDate: - Description: 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 valueFormat: YYYY-MM-DD (In UTC) - Tags: string, Optional #### endDate: - Description: 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) - Tags: string, Mandatory #### currency: - Description: All VISA network supported currencies. Supported currencies are mentioned under Resources. - Tags: String, Mandatory #### payoutType: - Description: The Type of the payout. Possible values: XB - Tags: string, Optional #### cardAlias: - Description: 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 - Tags: String, Mandatory #### rules: - Description: Any Rules to be set on Virtual Card - Value: - **BlockPayments**: - Description: 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 - Tags: List, Optional - **AmountRange**: - Description: Transaction amount range for the authorization. If not passed, no restrictions will be applied - Value: - **Min**: - Description: 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 - Tags: String, Optional - **Max**: - Description: 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 - Tags: String, Optional - Tags: Json, Optional - **ExactAmountApply**: - Description: 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. - Tags: List, Optional - **MccBlock**: - Description: 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. - Value: - **Min**: - Description: Min Range of the MCC that should be blocked. MCC list is shared in Resources tab under VISA Rules - Tags: String, Optional - **Max**: - Description: Max Range of the MCC that should be blocked.MCC list is shared in Resources tab under VISA Rules - Tags: String, Optional - Tags: Json Array, Optional - **MccAllow**: - Description: Range of MCC that should be allowed for payments. Upto 15 ranges are accepted Note: should not be passed if mccBlock is passed - Value: - **Min**: - Description: Min Range of the MCC that should be allowed.MCC list is shared in Resources tab under VISA Rules. - Tags: String, Optional - **Max**: - Description: Max Range of the MCC that should be allowed.MCC list is shared in Resources tab under VISA Rules - Tags: String, Optional - Tags: Json Array, Optional - Tags: Json, Optional #### isCardImageRequired: - Description: To get card image pass value as True. - Tags: Boolean, Optional #### expenseCategoryId: - Description: 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. - Tags: String, Mandatory #### udf1: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf2: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf3: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf4: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf5: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf6: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf7: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf8: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf9: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional #### udf10: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String, Optional ## API Responses: ### 200: #### 200 : Payout Response: - Value: - **Status**: - Description: Status of the API callPossible value: SUCCESS | FAILURE - Value: SUCCESS - Tags: String - **PayoutId**: - Description: Unique value of payout id which was sent in the request. - Value: Juspay123456789 - Tags: String - **Response**: - Description: response body parameters - Value: - **Expiry**: - Description: Contains the expiry month of the token. - Tags: String - **State**: - Description: Current status of the virtual token Possible Values: ISSUED | REDEEMED | PARTIALLY_REDEEMED | EXPIRED | DELETED - Tags: String - **PayoutAmount**: - Description: Total Amount = This is sum of orderAmount + gst - Tags: String - **Token**: - Description: Contains the token number. Will not be available for expired and deleted tokens - Tags: String - **Currency**: - Description: Currency of the VCC - Tags: String - **RedeemedAmount**: - Description: Total Redeemed Amount from the VCC - Tags: String - **CardAlias**: - Tags: String - **UserDefinedFields**: - Description: UDF details for particular payout - Value: - **Udf1-10**: - Description: Optional Field - Any unique ID which is required for searching on the Frontend Dashboard to be sent in this. - Tags: String - Tags: String - **ExpiryMonth**: - Description: Contains the expiry month of the token. - Tags: String - **CardImage**: - Description: Base 64 encoded string will be sent - Tags: String - **CardNetwork**: - Description: Issuing Network of the parent card - Tags: String - **CardIssuerBankName**: - Description: Issuing Bank of the parent card - Tags: String, Mandatory - Tags: String - **Message**: - Description: Reason for failure / success - Tags: String - Tags: Object ### 400: #### status: - Description: Key helps to identify if request is FAILURE or SUCCESS - Value: FAILURE - Tags: String #### message: - Description: Reason why the failure occurred - Value: Invalid Expense Id Passed - Tags: String #### payoutId: - Description: unique ID provided during card creation - Value: Juspay123456789 - Tags: String ### 401: #### message: - Description: Invalid credentials provided. - Value: Unauthorized: Basic auth missing in headers - Tags: String ### 500: #### message: - Description: Database Error. Validated Expense Data cannot be Empty - Tags: String