Body
Attempt API [Encrypted]
Attempt API is used for PLAIN_CARD payouts where merchant wants to retry on a failed attempt. Merchant can pass card details in this authenticated API from merchant's server. This API is to be used only for the use case where merchant has access to card details (either PAN or card token) and wants to implement retry for PLAIN_CARD payout orders.
Warning
Request data has to be sent in encrypted format. Please follow the steps mentioned here
The below params have to be stringified before encryption:
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/payout/merchant/v1/{orderId}/attempt
Production Link
POST
https://api.juspay.in/payout/merchant/v1/{orderId}/attempt
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
Please pass merchant-id given for your merchant
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Parameters
fulfillmentId
*
string
Required
Fulfillment ID received in the response of order create request
cardInfo
object
This will contain the details like cardNumber/cardToken and all other details related to CardToken.
cardNumber
string
Field will contain the card number used for the order
cardToken
string
Field will contain the network token used for the order
name
string
Name of the card holder / beneficiary for the order
cardExpiry
Object
This object contains expiry month and year of card
month
String
Expiry month for users card (MM)
Example: “01”
year
String
Expiry year for users card (YYYY)
Example : “2024”
senderDetails
Object
This will consist sender details. This is Mandatory fields for Credit Card Bill Payment Transactions via MASTERSEND Rail
type
String
Indicates the type of the payment done
Allowed Values : PAY_CARD, NETBANKING, UPI
details
Object
name
String
Name of the sender
account
String
Please populate this field with the accountNumber of the remitter if the paymentType is NETBANKING
pan
String
Please populate this with the card number or Token if the Type is PAY_CARD
expiry
String
Optional
Expiry details for sender’s card. This is an optional field
month
String
Expiry month for sender’s card (MM)
year
String
Expiry year for sender’s card (YYYY)
cardSecurityCode
String
Optional
Please populate this with the card security code if the paymentType is PAY_CARD
transactionReference
String
Please populate this filed with the unique transaction reference number if the paymentType is UPI
200 : Success
Response Body
ACK
String
400 : Invalid Input data
Response Body
error
Boolean
Boolean reflecting error in request of create order API
Example:- true
errorCode
String
Error code provided by Juspay
Example:- E01
errorMessage
String
Error message provided by Juspay. Share this message with Juspay POC for debugging
Example:- Amount0.0 cannot be less than 1.0Amount0.0 cannot be less than 1.0
userMessage
String
Error message that will be shown on dashboard / analytics
401 : Authentication Failed
Response Body
error
String
Boolean reflecting error in request of create order API
Example:- true
errorCode
String
Error code provided by Juspay
Example:- E02
errorMessage
String
Error message provided by Juspay. Share this message with Juspay POC for debugging
Example:- Invalid API key passed in request.
userMessage
*
String
Mandatory
Error message that will be shown on dashboard / analytics
Example:- Invalid API Key
Have questions?
- Need help? Contact support
- LLM? Read llms.txt