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

Setup Agentic Payment

This api is used to setup the limit of transaction for a particular VIC token transaction

Request

Response

API Endpoints

Sandbox Link

POST

https://api.juspay.in/cards/setUpAgenticPaymentInstruction

Production Link

POST

https://sandbox.juspay.in/cards/setUpAgenticPaymentInstruction

                      Basic Auth
                      *
                      

required

Consists of two parts.

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

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      *
                      

String

Mandatory

Merchantid of the AI Agent to be passed here

Body

Request Schema: application/json

                      cardNetwork
                      *
                      

ENUM

Mandatory

VISA

                      clientReferenceId
                      *
                      

String

Mandatory

Session identifier of VISA in the transaction flow

                      vProvisionedTokenId
                      *
                      

String

Mandatory

Token id of the card being used in the transaction

                      customerId
                      *
                      

String

Mandatory

Customerid of the user on the AI Agent

                      verificationData
                      *
                      

String

Mandatory

Assurance data passed as an input to setup mandate

                      verifyType
                      
                      

ENUM

Example:- DEVICE

                      methodResults
                      
                      

Object

                      dfpSessionId
                      
                      

String

Session id for the Passkey authentication

Example:- dnRzLmF1dGgudmlzYS5jb20=

                      identifier
                      
                      

String

Session identifier for VISA

Example:- 7fb2e19f349920dd330a1657984c4a01

                      fidoAssertionBlob
                      
                      

String

Assertion blob from the passkey verification

Example:- dj0xJmM9ezAwMX06QUFNMU5VR0d0Yk5OdHlsVnFQQzAyODF3RHBWTWZuZlFsUmdPRG1xQndzZnpRMkxJeGEvWnNMSk1pdlRRcUdvci9vb2pBclJvUmI5YjAzVXNUWlFwWjBhZnJTb28vU05NeDNtaHZjaTU4SDc4OGdIUXZtZkQ2US9WNi96UTFZbWFEbnR0OHZ3L0M5MFNGT1haUTErdVVjV25hcEV3aDczVzhmOVh4a3QrOENEdkMxL3EvcmhTQzBaUnFINUdlblZHWGpES3c0UGR3QUxwd3ZlaytwMEdiY2Vsd29HMmo2akNNSmphdzlGTmI0OU9KeVYwSUI0N3M1V2tOblpiZmFZZ3JHVTZIZkUwN1RZNlR2cHNOUHp1ZHJnMm1PR3VyYnhDTGhSVXdoZm5sZHdqMi9LTU1iT0lLeWg0QTdWb0dEWG5EL1lCRExmSk9IOWZUYkwrYXFWK0pvQS92dFdueTJIVEx4UVY3b1BIUnhKaW9kWm95NVp4MWdOYWVybWxrQTcvUWdjYjhmdUFHWDZGV0pIN3V5YThKOVNUZ242QVkxL29hYXJ5Z1hlZHQzbDNXT2U3dkRzT2FUdCtzWEZQT1llVU1DRVNIZFl1TkJJWGN0L0pOYy9HU1BNU3haS2dUbzFCZDR4THpZYmd1MVBrcU9xZGExK29NT3FyM3IxMUU3ZnlMQjFZMTBxc1R4V1lkNDdFRG9WUlhvaTV3R1l1WWNQZVNhSUJPVjVlYkFFMFhLNk4xN1lDYi92WGxBNVlMWEhSUjVaaDR4WGxSTzlDZ2hYUWRYV3pQb2FVbmxyT0ovTzdrRGdoMURtYU1WanBtWkcrdm90b3VwWlRqdHJWMnF5bGpCeXFEc2VPc2I2SVJqYTJtM0NXeWF5M1BTTjl6VWxLelpLazhnQ1JHR1RqRE1ab2FIUmxqVElPekRCQjI4V2ZvbUlOa1VhbTU2YmNVMEFiNUVPb2F3SDUzSDNXdTZyREMyK3BPTUFvdXA2T3hBb3RMSHJYUDFwa1djWGFVNWFJQStOTE92TWV2TnlIRkI0QTFGNCtnRFNRcGtlYW90VENjck00cCtJQ1JnNDZyVENXWEVhZ1RtRUs3a295YVFFTzg5TnY1eGQ2MytCbE9rYUh1WHpzbXZpU2RGcVltUTI0L2NaUmNDUGQ4ZUNRay9wa0JnN0huelVmNmNUQlJlWWs1Ymp2TlVPcjJaRWpwWGI0MzAyazVQNFVhcnlJQ2VuZ3FFMnV6WVJiNmVrWXlnSzd0andpckJXbkVrdUdURnQxaEVsRG8xVWxvOGRiQmE1M3lrRmxJSy93WVVEcDJSc3kxdnR0c2ZibXhxTzBkQjc5WTFpeGtZOFh4b2hLUjRXRnBhTEU5UXBJOWk2Z1k5bStyMFM3SnRGOXZiL2hEalVwY3ZlbEZKek9VMVR2T0I1bDA1WGpQYitmN21lYmhNMnl3RWlhYlk2b1QrbFRqNWl6N3ltVlVxL2RUSnd5VndIdFFwZGhKb0VJc09sbTAyRnhGNjVRWlRJWWZIdTVINlMzZ2lSRW41Y2w2cnlkREZhSTYzUXpOemF2akh3SmI2ZFpmZzh6UFM2Qm5GMUYxZlFKY1BCdlZZZ3FZK1pTNk5kNXpTR3RwOXZybitld2FCTkVEUkZ4VXN0bFNBekhmTWxTUXNsQStXM3N5aDRCR2M5M3RoTUR4eWNTbXRkaGRKT1hTMDJKc3ZjUW1Rd0hhS2x3L0FPaFVxZ1hQZHJFNGtNUlJpWnZIbmdqbTdyUytoVTBxakh2ZnBqRjVGYlNLV0ZLZlJJaHFLT1poeFJOamNxUC9TMUxIakhZeXZvdEhHRHExa0I2d1AzYmozeWRyTEVUWHYveVl2ZldrVjFrVnR5SUxWNDRVdHFza2JGb2tzMTV5Y2RKdlcxVGJ0VFV0Mno0RUxWOStCelJ0eUo5b3VCdGp2QythK0d1VGdtdXpCeEFuaENSa2had3pXaVZLQXMvVE41d1ZvdUJ2eTd2RDkrYnljYXlVZWRkL1NUaVNTNlF6bnJ6WmxmL0VhOHgzZlI4TWlCaWZrTHJXbnhJMkw5TklkT2FHdHcyVmFvRDJISWhCeUlFL2FxcjJTOXArREwrOWNrbmpyVnFEdytyaXh1OW5pVDUvYnNHWUtMNUFWZytvdWJhYjNrYytWTVQrdUZWNzF2L3p1YWovYlJmcXpXMERNVWFsNyt1VkNFOHZHZCsxUlZTdnNZZFFqVzJITCtWZ3ZhZUZ6cVBLSVpxZVZyaWcrY2JhZTBTak1KM2FlM0YxZDhrMU1NM1BsV0w4U3Z6MkNpTkNEdk1JZDZPNnNiaVVwZFV5RkQzUkxUVmhlS0dqY1FwUkpVbmRiM1N4SjVDMkhpbVptNFZzc3FyKytrV3g2enhibXFnYXdiQ2hzbzQwSklVVFhxRFh4WTJIb1IrckVIbWo2MDNHaTlUcGFiNFF3L1QzL2RkMXkyVU4zRHF0VW9ScSthR0JzSWFtOEVRbkM1Vk0rWGVzZ21mTFlTbjlMbDJpTVk5cE1xNWVqNHAxdlk1Y3JoSld2SkIvUFZIdnBHMENtb2p2c3JiMUlFR29WTmROZmpDU0lwNnRMTVNlQ0t2QnVlZ0FqVmt1VFJsUVlobFpLc2Jwb2FiNjR4K0hTMzNuNHFGdHVnNERQMXVFRkhDSjVCS3h1ckNUWHBXNnFGYmxvQmZhcDMweUZUN2pxSTV5UTZzNndVTUVIVW9lZWFtaGZiV0dtV2hESXl2RUpqTFRUcmt6eVhJZStyOGlBTEY2MTJmYk5NSUozc3FocVdCWm1oZGpOVWZWbUh0bUV5ZVRBUEpBdkx6dDZDbE42OGtxTU4yYVpzMElBMnE5QXVxbHVyVG83b0ZIMUNxUXg5SzhTQU9hV0d6N29HclIrSEtEZVJwdnJMT0FQdENBaGt3eE44cG4zYWsrRFdKellaRHVvamhlZDBTK1RBM1hrUzdrZ3JzOWtRZEhQWVU1QmF0ZCtjNDVLMUNEem5HbS9sNSs4T3ozZTlFME1mQTRrc1YxRlRBUjV4OGNqeUcyYmVUN0JINUlIQlIyanJUUUdjZng2L2YwTFhuT3hubHlONTh4bzRNUjNoM1FndzBySjRKaWpmanBPa2JEcFdKYUwya1VTd3BQclpuRWhVUWxCSSsrQ0xVRHhXSzdSK1k0eUxKOFlERnZDODBGZE54NzB6VklpOHlBS3JzR2lLQlA2VzYzSFN2SHRxMCt1OG40OHJkdmhkaUk2aEE0MDdzd2JNYWFlT0ZMV1ZwWnMvTkZuaWVwK0wwWFFkL0IrZDNtVk1uSlpMNG1VUmxPWHpkTVlacnZKR2Q5a3kvaVZOb3RhdkQza1NnMHFURk5yVWZyTTNFMk8zL2p6WCtvQUNsZGU1UlB0dHdLSGUxNUQzYUVXM0VnbUpOZXFlcUhxRHB5bEgyUGhFUWRxMTVPaHNadmg3dEhaWmg4RkIzTTRtaGZwWWd2WkhIOXRXNFdUN3diWjNEaWMvSHFucUdCbHN0dTgzSFVPWCtZeThxeHF2ZEd5STBpQ2JKMnZaSElQVlNNYlVNT0FJTFNyZDQrMDhHM2t5Qmc0TDNmam5ZOTYwcnB5MlR6cHFYcC9aSFBEYVd1Q0NCaWZzVjBrV0J4VHEzdDhyd2RCY1ovcjZacGFZaElnZXh6bUtXNnhmYlZUa1V6ZHFYWWhJblJnNjVYbEw4NHo5TkVDWFN1RFBnTEVRWmZHcURtWFlvMjdtTHRuTmI3QlRuVTlxUlVoTmdvL1hFVzRTUC9samhMVllSSFBKQVkvYm03VTU4M282Z1pWWlBjZFIvYU1nMXBmaXlxdlJWa0wxNmN1amM5Ymcvd0NpbE50cTY2alJrSkovL2wrMEo0NzBpRzFrcFg2K0ZUTTNGeHFIMlFJK3NJNWkxcDZROUwwb2V2U1pETUJ1b1c2YmRGTzkxN0J4NDdNeWtEenoxYzYwWnBISm9yWjUvTmpUNzVBSjA5MHFyL1NYNUpvZUhNbXpzdThheHM5clMwUUI5RE1qM1c4bzFuWXovRnlTZlpxc0pWWDFHdmgrZUtsekZkd1IyWElMc3FIZklXclRpaW5wSTRGVFRxWkU3Q25tZzhvbml3UENmRmVFQUwzaTMvc2ZaVGRCMGxpRmt1SHBySUhMVnBGakM5MCtQNisreGZIUzFPdzROLzNFQmZVVTdiYW5oWmw2aHlKWGhSVlJhNmJ5WWlJZUJLUS9BWmMwYzJqWC9TM0xZSTJRc3dXVGpGYkdSVjljUmRQWVVFVmllQVZ6TFF5S1hHemlEakJtYWpmenhrM0JUWjlqNjd1SEsra1VnY08zeERTU0NNNW11a2R5eFplOWY4anFzWHR4UUxaK1VuZm1FYVdCQmxVc3QyZG5abE5DQmpQSjNjbHowSzE5WDM4eXh3emhPQjZTeWtjM0hkd2lnbWExZFJmdkNFKzA3VE8vYXlIbE1pY2g3eFhrbHhCcFZSK0FLcWI5SnJpQTc1cVAvU3FwMXNPeUNwUkYvUnZEaDcxOFB4RjFJUWtDNjdYWU1aSzRHUWl6ODhncDhEai9idk82d25Oc0JKVHJ6UzBoSVplNmxWRnQ5YVZwM2xoL2FSazBvdGNxNHdzblo4c0gyNTlIbHA4Z2tvZFRjNFgxZmQyZ1pEL1pYbTEvck54T2ZzWENaeG1ZTUo4NWpSRnA5SnkxK2tEdGpwUk04d0xSU09nanlBckNFSHJxSjY5S1VTUzd5eW85UGV0ZmlkUDVKV3ppOHNad2kxcjZ5ZlRKNUNUVVovejdORERtNkI0ekhCR3J4R2R6TE5KRjRjM003aDRkUGN1YTcrUTAwczZySThiaU9FcTNkRzFmR05ya0h4N1BwdEFGWHluYkZwVzRoRy9MT2VHVm4yNHJJTzdUcWZQOWxzV2J1bitreDRQa3h1RjU3MXMwcFFJbUNaZWg3V25pSkZIME5ia3FEenVoK0xNMmRGY255SnBhaW84KzhoUmF6c21lTVNXWlc0ZXFzYlVEUTNxVVRkQWRvNDRaY2p1dGt0K1pldEF3M0tNb2IyTHZxM0RKS0daNG9wNTlYSFFQaGNnR3pnUXI0ek1BQ3JJZDFXZHNZK0NVU3B2c2trZUlkYkk3Z081Qm90MlpVZGJRbVAwWFgyVzZyV202dHZDOCtUbWRscXpRMUZuYTdDODlpZ3BBVmdselV0SjhGL2tPWUJtNDh4enJwL3NFYWQ1TURaaXN1d1pwTTdvaHdUVmNYbTgwMTJOUU15d0l5VTVpNjMvZW1EUjQyYmRlTjZjcHc4by92Rmg5R3lkMWlOK0xycXJya3JxTUJ2TzJ0WSs1MFlxTkhaTGNldmtycVBuOWp0SzgrZXltL0thTE02U0NJSStOaDZvQjNvN1NycTAxa1l1cDdUTC8waElMcnZDNm5MR3lpS0RFa3REWEc1K2UybUpacE8wLzBIT2lpS3lKSENzb2dzYyt0cUF2SVM1bXF1djBrbHpxK2dRaHpiZWR0cnZMNTV5U0dtc2s5WUgva3ptOE9hVnRDTE1LR01NYXIwYVZPS2d4ZjBtRmJudU9UOFB1NzF2dkhxVjFzc25sOGtyMHRmeVpGLzFROG5kOEZyc29yYSswZXl1MmF0UnpiaVhaY2p5TzNLSWkybjMvbjc1cXEvUWxYMDZtRXlBc1JValR4MkIyTTVndGlOM0hMZmRmZ21CRmNjL0VKT3IrVm9kOWVZTnlkc0VvbWRQeDZJZDYrQ0NEaVRrM3RVZ3R3ZXZYZHhwMDVjbzVZcHd1VDAwZmVSV0JOTE52eEhEaG5lSXBkUXZLVUsyb1k5Z2JxdFY5bzVjZEJPbWN6aVRUVnBZV282eStyWkMray9MYXR2aXdqbHNsTWE3Nm9CUEFsQm9XTnUzbjNoK0tyOVFjTjFlSHBqQVgzY2RUNnRXUjM1ZzhuTzIvak1BTGU3M2doaTdYQWdhelp4YittTGF6QzlKNjg2S3JZL2g0WmNpNVNZTi96N2NwNTdZRFRjQlg0cmxFcDBDUUFJR0M2WXQ1emZzT085RG1oWENZak45UDRILytUQjNWMWNmOGh5SGlhWGhwZCswUzBWQlJBU1FnUVN3VEVVRVJGWTBHSXNPeWxEN3c4eHc0OG55WVhkbXFYQTI1NnZUVDc4QTF6VC9vRTJzc1NCSW1FSVhCVE1LeVBVM2JFZHJMZmJ2ZHo2YXM1amdLdmNJclBnbUprcGEzMmx4c2t5N2xCQmhySVZyd1A4VDNLeVd3a1ZsL1RHRUQ2MHVJZFFhUU56T0ozOVAwMmRiVWFJd0tzelBPYTJNUld6R1llNnJhTjU2eVhhYkRFdEZMZ3IvVmpaellkTmgxVUxtcG1wUWx6bWJRU3dsZHYwZGZ1eEVCMXJFYzhpY3VsZVBKYWlUM3JWUXE4L0NwSTRsSWdzcXJWSWNHdGJWWmNUZS9uN0dEU1BDdll3TVczdDdVZGZwQVprdU00c1NsVUlKRytQWHV1K2lmV0RGQ0psWEtJNDVVcTFoVytaN3VwTjhwL2I3VWJJcUNlMmdpSEJSNW1kUnRJNDlod3A0RT0maD0xX2pFZDRKQSZ0PTI

                      mercCategoryLimit
                      *
                      

String

Mandatory

Limit on the transaction that can be done on this merhcant

                      limitId
                      
                      

String

Identifier of the mandate

Example:- limit-001

                      thresholdAmount
                      
                      

Decimal

Maximum amount for the transaction

Example:- 97.65

                      thresholdCurrencyCode
                      
                      

String

Currency code of the transaction

Example:- SGD

                      description
                      
                      

String

Example:- Spending cap for groceries

                      effectiveTime
                      
                      

String

Timestamp from which the mandate is active

Example:- 1770802952

                      appDetails
                      *
                      

String

Mandatory

Device user agent related details are added in this key

                      userAgent
                      
                      

String

Example:- Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36

                      ipAddress
                      
                      

String

Example:- 104.28.3.64

                      deviceData
                      
                      

Object

                      model
                      
                      

String

Example:- Macintosh

                      brand
                      
                      

String

Example:- Apple

                      manufacturer
                      
                      

String

Example:- Apple

                      appName
                      
                      

String

Optional

                      countryCode
                      *
                      

String

Mandatory

Country code of the transaction

Response Body

                      status
                      
                      

String

Example:- SUCCCESS

                      responseCode
                      
                      

                      responseMessage
                      
                      

                      payload
                      
                      

Object

                      transactionId
                      
                      

String

Example:- some-txn-id

                      clientReferenceId
                      
                      

String

Example:- client-ref-id

                      nwStatus
                      
                      

String

Example:- SUCCESS