Payment
The Payment module lists cards and payment modes, allows for the selection of payment modes during checkout, handles refunds, validates customers, and ensures the security of transactions.
Beneficiary
Beneficiary for a refund refers to the individual or entity who will receive the refunded amount. This could be the original purchaser of the product or service, or it could be someone else if the refund is being processed on their behalf.
Operations
GET
# Retrieve beneficiary details
GET
Retrieve beneficiary details
Get beneficiaries associated with the user for processing refunds, based on the provided order ID.
Parameters
orderId
string
Required
A unique number used for identifying and tracking your orders.
Response
200
400
500
Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.
OrderBeneficiaryResponse
show_beneficiary_details
boolean
Show beneficiary details or not.
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order.
Array of OrderBeneficiaryDetails
Examples
Parameters
orderId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieve beneficiary details
getUserBeneficiariesDetail
Card
Payment cards eases the process of payment for orders. Customers can securely save multiple payment cards within the payment gateway. During payment of an order, the list of payment options will show the list of saved cards. Link cards to customers, fetch active tokenized card information, tokenize and save cards after customer consent, and remove customer's cards from the payment gateway.
Operations
POST
# Link payment card to customer
GET
# Retrieve active card aggregator
GET
# Get customer cards
POST
# Delete customer card
GET
# Get card details
POST
Link payment card to customer
Link payment card to a user account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments.
Parameters
body
object (AttachCardRequest)
Required
Pass the Card ID in the request body as shown below.
AttachCardRequest
nickname
string
Nickname of the card holder.
Default Value :
refresh
boolean
Nullable
Refresh cache flag.
card_id
string
Nullable
Required
Card token of payment gateway.
name_on_card
string
Name of the card holder.
Default Value :
Response
200
400
500
Success. Check the example shown below or refer `AttachCardsResponse` for more details.
AttachCardsResponse
data
object
List of cards of customer.
success
boolean
Response is successful or not.
message
string
Human readable message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Link payment card to customer
attachCardToCustomer
GET
Retrieve active card aggregator
Get details about the active card aggregator used by the user, including the aggregator name.You can refresh the data by setting the 'refresh' parameter to true if needed.
Parameters
refresh
boolean
Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
Default Value : false
Response
200
400
500
Success. Returns an active payment gateway. Check the example shown below or refer `ActiveCardPaymentGatewayResponse` for more details.
ActiveCardPaymentGatewayResponse
cards
object (CardPaymentGateway)
CardPaymentGateway
success
boolean
Response is successful or not.
message
string
Human readable message.
Examples
Parameters
refresh:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieve active card aggregator
getActiveCardAggregator
GET
Get customer cards
List all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired.
Parameters
forceRefresh
boolean
Select `true` to clear the cache.
Default Value : false
Response
200
400
500
Success. Returns a list of cards saved by the user. Check the example shown below or refer `ListCardsResponse` for more details.
ListCardsResponse
data
array of object (Card)
List of cards of customer.
Array of Card
success
boolean
Response is successful or not.
message
string
Human readable message.
Examples
Parameters
forceRefresh:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get customer cards
getActiveUserCards
POST
Delete customer card
Delete payment card from the user's account.
Parameters
body
object (DeletehCardRequest)
Required
Pass the Card ID in the request body as shown below.
DeletehCardRequest
card_id
string
Nullable
Required
Card token of payment gateway.
Response
200
400
500
Success. Returns a success message if card is deleted.
DeleteCardsResponse
success
boolean
Response is successful or not.
message
string
Nullable
Human readable message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Delete customer card
deleteUserCard
GET
Get card details
Get details of a specified payment card, including information such as the card type, brand, country, and expiration date.
Parameters
cardInfo
string
Required
Card first 6 digit IIN(prefix) number.
aggregator
string
This is a string value describing the aggregator name.
Default Value : juspay
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `CardDetailsResponseSchema` for more details.
CardDetailsResponse
data
object (CardDetails)
CardDetails
success
boolean
Response is successful or not.
Examples
Parameters
cardInfo:
"value"
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get card details
cardDetails
Order
Order refers to a formal request made by a customer to purchase one or more products or services from the website's catalog. orders feature lets users easily start new transactions. It helps manage pending orders by providing key details like unpaid amounts and order statuses. Additionally, it offers detailed info on completed orders that have been successfully paid for.
Operations
GET
# Outstanding orders
GET
# Retrieve details of paid orders
POST
# Create Order
GET
Outstanding orders
Get details of orders with outstanding payments.
Parameters
aggregator
string
Merchant user ID as value.
Response
200
400
500
Success. Returns the status of API. Check the example shown below or refer `PaidOrderDetailsResponseSchema` for more details.
OutstandingOrderDetailsResponse
status_code
integer
| int32
HTTP Status code.
data
array of object
Nullable
Dict containing the outstanding order details.
success
boolean
Response is successful or not.
message
string
Nullable
Message.
Examples
Parameters
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Outstanding orders
outstandingOrderDetails
GET
Retrieve details of paid orders
Get details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator merchant user ID.
Parameters
aggregator
string
Merchant user ID as value.
Response
200
400
500
Success. Returns the status of API. Check the example shown below or refer `PaidOrderDetailsResponseSchema` for more details.
PaidOrderDetailsResponse
status_code
integer
| int32
HTTP Status code.
data
array of object
Nullable
Dict containing the paid order details.
success
boolean
Response is successful or not.
message
string
Nullable
Message.
Examples
Parameters
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieve details of paid orders
paidOrderDetails
POST
Create Order
Create an order and payment on the aggregator side.
Parameters
body
object (PaymentOrderRequest)
Required
Pass the details in the request body as shown below.
PaymentOrderRequest
payment_methods
array of object (PaymentOrderMethods)
All payment methods for order.
Array of PaymentOrderMethods
order_id
string
Required
Order id.
shipment_id
string
Shipment_id.
Response
200
400
500
Success. Check the example shown below
PaymentOrderResponse
payment_confirm_url
string
Nullable
Payment confirm url for aggregator.
callback_url
string
Nullable
Callback url for aggregator.
order_id
string
Nullable
Merchant order id.
success
boolean
Successful or failure.
status_code
integer
| int32
HTTP status code.
data
object (PaymentOrderData)
PaymentOrderData
message
string
Detailed message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create Order
createPaymentOrder
Paylater
PayLater, also known as "Buy Now, Pay Later" (BNPL), is a payment method that allows customers to make purchases and defer payment for those purchases to a later date. With PayLater, customers can buy products or services immediately and then repay the amount owed over time, typically in installments. Efficiently retrieve repayment transaction details, initiate merchant onboarding for BNPL, and Validate Customer Eligibility for Paylater Payment Options.
Operations
POST
# Verify payment customer
POST
# Verify order confirmation and charge
POST
Verify payment customer
Verify if the user is eligible for pay-later payment from the payment aggregator side using the customer's phone number.
Parameters
body
object (ValidateCustomerRequest)
Required
Pass the payload, payment aggregator, phone number and other details in the request body as shown below.
ValidateCustomerRequest
aggregator
string
Required
Payment gateway name in camelcase i.e Simple, Rupifi.
transaction_amount_in_paise
integer
| int32
Required
Payable amount in paise.
phone_number
string
Required
User mobile number without country code.
billing_address
object
Extra meta fields.
order_items
array of object
Extra meta fields.
payload
string
Nullable
Hashed payload string.
merchant_params
object
Extra meta fields.
delivery_address
object
Extra meta fields.
Response
200
400
500
Success. Check the example shown below or refer `ValidateCustomerResponse` for more details.
ValidateCustomerResponse
data
object
Payment gateway response data.
success
boolean
Response is successful or not.
message
string
Error or success message.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Verify payment customer
verifyCustomerForPayment
POST
Verify order confirmation and charge
Verify the payment status and charge from the customer's BNPL (Buy Now, Pay Later) account after order confirmation.
Parameters
body
object (ChargeCustomerRequest)
Required
Pass the transaction token, order ID, payment aggregator, verified status and amount in the request body as shown below.
ChargeCustomerRequest
verified
boolean
Nullable
Already Verified flag from payment gateway i.e Mswipe.
aggregator
string
Required
Payment gateway name i.e Simpl, Mswipe.
order_id
string
Required
Unique order id.
transaction_token
string
Nullable
Transaction token of payment gateway.
amount
integer
| int32
Nullable
Required
Chargeable amount of order.
Response
200
400
500
Success. Check the example shown below or refer `ChargeCustomerResponse` for more details.
ChargeCustomerResponse
status
string
Status of charged payment.
cart_id
string
Nullable
Cart id of customer.
success
boolean
Response is successful or not.
aggregator
string
Payment gateway name i.e Simpl, Mswipe.
message
string
Human readable message.
order_id
string
Unique order id.
delivery_address_id
string
Nullable
Delivery address id of customer.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify order confirmation and charge
verifyAndChargePayment
Payment
Payment system refers to the mechanism by which customers can securely and conveniently pay for the products or services they wish to purchase. It involves integrating various payment methods such as credit/debit cards, digital wallets, bank transfers, and sometimes cash on delivery (COD) to accommodate different customer preferences.It typically involves - Payment Gateway Integration: Connecting the website to payment gateways like PayPal, Stripe, or other third-party processors to facilitate online transactions securely. Secure Transactions: Implementing encryption protocols and secure socket layers (SSL) to protect customers' payment information from unauthorized access or cyber threats. Multiple Payment Options: Offering diverse payment methods to cater to a wide range of customers, including credit/debit cards, digital wallets (e.g., Apple Pay, Google Pay), and alternative methods like cryptocurrencies or buy-now-pay-later services. Checkout Process: Streamlining the checkout process to minimize friction and make it easy for customers to complete their purchases swiftly. Payment Confirmation: Providing instant confirmation of successful payments and sending receipts or order confirmations to customers via email or SMS.
Operations
GET
# Get payment aggregators
POST
# Start payment process
POST
# Update payment status
GET
# Get payment modes
GET
# POS payment modes
POST
# Initiate linking of wallet
POST
# OTP verification
POST
# Delink the wallet
POST
# Render HTML
POST
# Validate VPA
GET
# Credit summary
GET
# Redirects users to the payment aggregator's interface
GET
# Verify credit availability and status
POST
# Onboard customer for payment
GET
Get payment aggregators
Get aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway.
Parameters
xApiToken
string
Basic auth token.
refresh
boolean
Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
Response
200
400
500
Success. Returns the keys of all payment gateways. Check the example shown below or refer `AggregatorsConfigDetailResponse` for more details.
AggregatorsConfigDetailResponse
success
boolean
Api response was successful or not.
razorpay
object (AggregatorConfigDetail)
AggregatorConfigDetail
juspay
object (AggregatorConfigDetail)
AggregatorConfigDetail
simpl
object (AggregatorConfigDetail)
AggregatorConfigDetail
payumoney
object (AggregatorConfigDetail)
AggregatorConfigDetail
rupifi
object (AggregatorConfigDetail)
AggregatorConfigDetail
mswipe
object (AggregatorConfigDetail)
AggregatorConfigDetail
stripe
object (AggregatorConfigDetail)
AggregatorConfigDetail
ccavenue
object (AggregatorConfigDetail)
AggregatorConfigDetail
env
string
Environment i.e Live or Test.
Examples
Parameters
xApiToken:
"value"
refresh:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get payment aggregators
getAggregatorsConfig
POST
Start payment process
Initiate the payment procedure for an order. Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID.
Parameters
body
object (PaymentInitializationRequest)
Required
Check the example of a request body below or refer `PaymentInitializationRequest` for more details.
PaymentInitializationRequest
razorpay_payment_id
string
Nullable
Payment gateway payment id.
method
string
Required
Payment method.
device_id
string
Nullable
EDC machine Unique Identifier.
aggregator
string
Required
Payment gateway name.
customer_id
string
Required
Payment gateway customer id.
contact
string
Required
Customer valid mobile number.
merchant_order_id
string
Required
Unique fynd order id.
vpa
string
Nullable
Customer vpa address.
order_id
string
Required
Payment gateway order id.
currency
string
Required
Currency code.
timeout
integer
| int32
Nullable
Payment polling timeout if not received response.
amount
integer
| int32
Nullable
Required
Payable amount.
email
string
| email
Required
Customer valid email.
Response
200
400
500
Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.
PaymentInitializationResponse
status
string
Status of payment.
razorpay_payment_id
string
Nullable
Payment id.
aggregator_order_id
string
Payment order id.
method
string
Payment method.
success
boolean
Response is successful or not.
upi_poll_url
string
Nullable
UPI poll url.
virtual_id
string
Nullable
Payment virtual address.
device_id
string
Nullable
EDC machine Unique Identifier.
polling_url
string
Polling url.
aggregator
string
Payment gateway name.
merchant_order_id
string
Order id.
customer_id
string
Nullable
Payment gateway customer id.
vpa
string
Nullable
Customer vpa address.
currency
string
Nullable
Currency code.
timeout
integer
| int32
Nullable
Timeout.
amount
integer
| int32
Nullable
Payable amount.
bqr_image
string
Nullable
Bharat qr image url.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Start payment process
initialisePayment
POST
Update payment status
Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions.
Parameters
body
object (PaymentStatusUpdateRequest)
Required
Check the example of a request body below or refer `PaymentStatusUpdateRequest` for more details.
PaymentStatusUpdateRequest
status
string
Status of payment.
merchant_transaction_id
string
Unique fynd transaction id.
method
string
Required
Payment method.
device_id
string
Nullable
EDC machine Unique Identifier.
aggregator
string
Required
Payment gateway name.
customer_id
string
Payment gateway customer id.
contact
string
Customer valid mobile number.
merchant_order_id
string
Required
Unique fynd order id.
vpa
string
Customer vpa address.
order_id
string
Payment gateway order id.
currency
string
Currency code.
amount
integer
| int32
Nullable
Payable amount.
email
string
| email
Customer valid email.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.
PaymentStatusUpdateResponse
status
string
Payment status.
success
boolean
Nullable
Response is successful or not.
retry
boolean
Response is successful or not.
redirect_url
string
Nullable
Redirect url.
aggregator_name
string
Payment gateway name.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update payment status
checkAndUpdatePaymentStatus
GET
Get payment modes
Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'.
Parameters
amount
integer
Required
Payable amount.
cartId
string
Identifier of the cart.
checkoutMode
string
Option to checkout for self or for others.
refresh
boolean
Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
orderId
string
Identifier of the order, order_id.
cardReference
string
Card reference id of user's debit or credit card.
userDetails
string
URLencoded JSON containing details of an anonymous user.
displaySplit
boolean
Display Split Payment Option or not.
advancePayment
boolean
Display Advance Payment Options or Normal.
shipmentId
string
Identifier of the shipment, shipment_id.
Response
200
400
500
Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
PaymentModeRouteResponse
payment_options
object (PaymentOptionAndFlow)
PaymentOptionAndFlow
success
boolean
Response is successful or not.
payment_breakup
object
Payment Breakup for advance payment.
advance_payment
array of object (AdvancePaymentObject)
Nullable
Advance Payment Array.
Array of AdvancePaymentObject
Examples
Parameters
amount:
0
cartId:
"value"
checkoutMode:
"value"
refresh:
false
orderId:
"value"
cardReference:
"value"
userDetails:
"value"
displaySplit:
false
advancePayment:
false
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get payment modes
getPaymentModeRoutes
GET
POS payment modes
Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'.
Parameters
amount
integer
Required
Payable amount.
cartId
string
Identifier of the cart.
pincode
string
Required
The PIN Code of the destination address, e.g. 400059.
checkoutMode
string
Option to checkout for self or for others.
refresh
boolean
Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
cardReference
string
Card reference id of user's debit or credit card.
orderType
string
Required
The order type of shipment
HomeDelivery - If the customer wants the order home-delivered
PickAtStore - If the customer wants the handover of an order at the store itself.
userDetails
string
URLencoded JSON containing details of an anonymous user.
Response
200
400
500
Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
PaymentModeRouteResponse
payment_options
object (PaymentOptionAndFlow)
PaymentOptionAndFlow
success
boolean
Response is successful or not.
payment_breakup
object
Payment Breakup for advance payment.
advance_payment
array of object (AdvancePaymentObject)
Nullable
Advance Payment Array.
Array of AdvancePaymentObject
Examples
Parameters
amount:
0
cartId:
"value"
pincode:
"value"
checkoutMode:
"value"
refresh:
false
cardReference:
"value"
orderType:
"value"
userDetails:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
POS payment modes
getPosPaymentModeRoutes
POST
Initiate linking of wallet
Link wallet for the aggregator for processing of payment.
Parameters
body
object (WalletLinkRequestSchema)
Required
WalletLinkRequestSchema
aggregator
string
Required
Aggregator Name.
mobile
string
Required
Mobile Number for Wallet.
wallet_code
string
Required
Wallet Code.
Response
200
400
OTP for Wallet Linking sent
WalletResponseSchema
data
object
Response received from aggregator.
success
boolean
Success/Failure of the API call.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Initiate linking of wallet
walletLinkInitiate
POST
OTP verification
Verify the linking of wallet using OTP for further processing of payment.
Parameters
body
object (WalletVerifyRequestSchema)
Required
WalletVerifyRequestSchema
aggregator
string
Required
Aggregator Name.
link_token
string
Required
Token for wallet linking.
otp
integer
Required
OTP received for wallet linking.
Response
200
400
OTP Verification
WalletResponseSchema
data
object
Response received from aggregator.
success
boolean
Success/Failure of the API call.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
OTP verification
linkWallet
POST
Delink the wallet
Delink the wallet.
Parameters
body
object (WalletDelinkRequestSchema)
Required
WalletDelinkRequestSchema
aggregator
string
Required
Aggregator Name.
wallet_code
string
Required
Wallet Code.
Response
200
400
Wallet delinked successfully
WalletResponseSchema
data
object
Response received from aggregator.
success
boolean
Success/Failure of the API call.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Delink the wallet
delinkWallet
POST
Render HTML
Render HTML for a payment aggregator page.
Parameters
body
object (renderHTMLRequest)
Required
Check the example of a request body below or refer `renderHTMLRequest` for more details.
renderHTMLRequest
returntype
string
Nullable
Return Type of API.
base64_html
string
Required
Base64 encoded html string.
Response
200
400
500
Success and return HTML decoded text
renderHTMLResponse
html
string
HTML string.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Render HTML
renderHTML
POST
Validate VPA
Validate if a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments.
Parameters
body
object (ValidateVPARequest)
Required
Check the example of a request body below or refer `ValidateVPARequestSchema` for more details.
ValidateVPARequest
upi_vpa
string
Required
UPI ID.
aggregator
string
Aggregator slug.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `ValidateVPAResponseSchema` for more details.
ValidateVPAResponse
data
object (ValidateUPI)
ValidateUPI
success
boolean
Response is successful or not.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Validate VPA
validateVPA
GET
Credit summary
Get summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL.
Parameters
aggregator
string
Aggregator name.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `CustomerCreditSummaryResponseSchema` for more details.
CustomerCreditSummaryResponse
data
object (CreditSummary)
CreditSummary
success
boolean
Payment confirmation updated or not.
Examples
Parameters
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Credit summary
customerCreditSummary
GET
Redirects users to the payment aggregator's interface
Get details about the active card aggregator used by the user, including the aggregator's name. You can refresh the data by setting the 'refresh' parameter to true if needed.
Parameters
source
string
Callback URL to get callback from aggregator.
aggregator
string
Aggregator name.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `RedirectToAggregatorResponseSchema` for more details.
RedirectToAggregatorResponse
data
object (RedirectURL)
RedirectURL
success
boolean
Status updated or not.
Examples
Parameters
source:
"value"
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Redirects users to the payment aggregator's interface
redirectToAggregator
GET
Verify credit availability and status
Check the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered.
Parameters
aggregator
string
Aggregator name.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `CheckCreditResponseSchema` for more details.
CheckCreditResponse
data
object (CreditDetail)
CreditDetail
success
boolean
Operation is successful or not.
Examples
Parameters
aggregator:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Verify credit availability and status
checkCredit
POST
Onboard customer for payment
Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability.
Parameters
body
object (CustomerOnboardingRequest)
Required
Check the example of a request body below or refer `CustomerOnboardingRequestSchema` for more details.
CustomerOnboardingRequest
personal_info
object (UserPersonalInfoInDetails)
UserPersonalInfoInDetails
mcc
string
Nullable
Merchant Category Code, indicating the type of business.
aggregator
string
Required
Payment aggregator handling the transaction.
marketplace_info
object (MarketplaceInfo)
MarketplaceInfo
source
string
| url
Required
Callback url.
business_info
object (BusinessDetails)
BusinessDetails
device
object (DeviceDetails)
DeviceDetails
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `CustomerOnboardingResponseSchema` for more details.
CustomerOnboardingResponse
data
object (OnboardSummary)
OnboardSummary
success
boolean
Status updated or not.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Onboard customer for payment
customerOnboard
Payment link
Payment link is a URL or hyperlink that directs users to a webpage where they can make a payment for their products. It's often used in situations where the seller needs to collect payment from a customer who is not physically present or when the payment needs to be processed remotely. Payment links can be sent via email, SMS, messaging apps, or embedded on a website, allowing customers to conveniently complete their transactions online. Enable the creation and management of payment links
Operations
POST
# Resend or cancel a pending payment transaction
GET
# Get payment link
POST
# Create payment link
POST
# Resend payment link
POST
# Cancel payment link
GET
# Payment modes for payment link
GET
# Poll status of payment link
POST
# Create order for payment via link
POST
# Initialize payment link
POST
# Update payment link status
POST
Resend or cancel a pending payment transaction
Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing.
Parameters
body
object (ResendOrCancelPaymentRequest)
Required
Check the example of a request body below or refer `ResendOrCancelPaymentRequest` for more details.
ResendOrCancelPaymentRequest
order_id
string
Required
Unique order id.
device_id
string
Nullable
EDC machine Unique Identifier.
request_type
string
Required
Either resend or cancel.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `ResendOrCancelPaymentResponse` for more details.
ResendOrCancelPaymentResponse
data
object (LinkStatus)
LinkStatus
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Resend or cancel a pending payment transaction
resendOrCancelPayment
GET
Get payment link
Get a generated payment link.
Parameters
paymentLinkId
string
Unique payment link id.
Response
200
400
500
Success. Check the example shown below
GetPaymentLinkResponse
status_code
integer
| int32
HTTP status code.
payment_link_current_status
string
Nullable
Status of payment link.
success
boolean
Successful or failure.
polling_timeout
integer
| int32
Nullable
Polling request timeout.
payment_link_url
string
Nullable
Url of payment link.
external_order_id
string
Nullable
Merchant order id.
message
string
Detailed message.
merchant_name
string
Nullable
Merchant name.
amount
number
| float
Nullable
Total value of order.
Examples
Parameters
paymentLinkId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get payment link
getPaymentLink
POST
Create payment link
Create new payment link for transactions.
Parameters
body
object (CreatePaymentLinkRequest)
Required
Pass the external_order_id, amount, mobile number and other details in the request body as shown below.
CreatePaymentLinkRequest
description
string
Nullable
Merchant order id.
external_order_id
string
Required
Merchant order id.
mobile_number
string
Required
Mobile number to which the payment link is to be sent.
amount
number
| float
Required
Total value of order.
meta
object (CreatePaymentLinkMeta)
Required
CreatePaymentLinkMeta
email
string
Required
Email to which the payment link is to be sent.
Response
200
400
500
Success. Check the example shown below
CreatePaymentLinkResponse
status_code
integer
| int32
HTTP status code.
success
boolean
Successful or failure.
polling_timeout
integer
| int32
Nullable
Polling request timeout.
payment_link_url
string
Nullable
Url of payment link.
message
string
Detailed message.
payment_link_id
string
Nullable
Unique id of payment link.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create payment link
createPaymentLink
POST
Resend payment link
Resend an existing payment link to the user to complete the payment.
Parameters
body
object (CancelOrResendPaymentLinkRequest)
Required
Pass payment_link_id
CancelOrResendPaymentLinkRequest
payment_link_id
string
Required
Unique id of payment link.
Response
200
400
500
Success. Check the example shown below
ResendPaymentLinkResponse
status_code
integer
| int32
HTTP status code.
polling_timeout
integer
| int32
Nullable
Polling request timeout.
success
boolean
Successful or failure.
message
string
Detailed message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Resend payment link
resendPaymentLink
POST
Cancel payment link
Cancel previously generated payment link.
Parameters
body
object (CancelOrResendPaymentLinkRequest)
Required
Pass the payment_link_id
CancelOrResendPaymentLinkRequest
payment_link_id
string
Required
Unique id of payment link.
Response
200
400
500
Success. Check the example shown below
CancelPaymentLinkResponse
status_code
integer
| int32
HTTP status code.
success
boolean
Successful or failure.
message
string
Detailed message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Cancel payment link
cancelPaymentLink
GET
Payment modes for payment link
List payment modes available for a given payment link.
Parameters
paymentLinkId
string
Required
Payment link id.
Response
200
400
500
Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
PaymentModeRouteResponse
payment_options
object (PaymentOptionAndFlow)
PaymentOptionAndFlow
success
boolean
Response is successful or not.
payment_breakup
object
Payment Breakup for advance payment.
advance_payment
array of object (AdvancePaymentObject)
Nullable
Advance Payment Array.
Array of AdvancePaymentObject
Examples
Parameters
paymentLinkId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Payment modes for payment link
getPaymentModeRoutesPaymentLink
GET
Poll status of payment link
Get real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired.
Parameters
paymentLinkId
string
Unique payment link id.
Response
200
400
500
Success. Check the example shown below
PollingPaymentLinkResponse
status
string
Nullable
Status of payment link.
status_code
integer
| int32
Nullable
HTTP status code.
success
boolean
Nullable
Successful or failure.
http_status
integer
| int32
Nullable
HTTP status code.
message
string
Nullable
Detailed message.
order_id
string
Nullable
Fynd order id.
redirect_url
string
Nullable
Url to redirect to.
payment_link_id
string
Nullable
Payment link id.
aggregator_name
string
Nullable
Aggregator name.
amount
number
| float
Nullable
Total amount for the transaction.
Examples
Parameters
paymentLinkId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Poll status of payment link
pollingPaymentLink
POST
Create order for payment via link
Initiate the creation of an order handler for processing payments through a link.
Parameters
body
object (CreateOrderUserRequest)
Required
Pass the details in the request body as shown below.
CreateOrderUserRequest
failure_callback_url
string
Required
Failure page url.
currency
string
Required
Currency of the transaction.
payment_link_id
string
Required
Unique id of payment link.
payment_methods
object (CreateOrderUserPaymentMethods)
Required
CreateOrderUserPaymentMethods
success_callback_url
string
Required
Success page url.
meta
object
Nullable
Meta details.
Response
200
400
500
Success. Check the example shown below
CreateOrderUserResponse
status_code
integer
| int32
HTTP status code.
success
boolean
Successful or failure.
data
object (CreateOrderUserData)
CreateOrderUserData
message
string
Detailed message.
order_id
string
Nullable
Merchant order id.
callback_url
string
Nullable
Callback url for aggregator.
payment_confirm_url
string
Nullable
Payment confirm url for aggregator.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create order for payment via link
createOrderHandlerPaymentLink
POST
Initialize payment link
Begin payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information.
Parameters
body
object (PaymentInitializationRequest)
Required
Check the example of a request body below or refer `PaymentInitializationRequest` for more details.
PaymentInitializationRequest
razorpay_payment_id
string
Nullable
Payment gateway payment id.
method
string
Required
Payment method.
device_id
string
Nullable
EDC machine Unique Identifier.
aggregator
string
Required
Payment gateway name.
customer_id
string
Required
Payment gateway customer id.
contact
string
Required
Customer valid mobile number.
merchant_order_id
string
Required
Unique fynd order id.
vpa
string
Nullable
Customer vpa address.
order_id
string
Required
Payment gateway order id.
currency
string
Required
Currency code.
timeout
integer
| int32
Nullable
Payment polling timeout if not received response.
amount
integer
| int32
Nullable
Required
Payable amount.
email
string
| email
Required
Customer valid email.
Response
200
400
500
Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.
PaymentInitializationResponse
status
string
Status of payment.
razorpay_payment_id
string
Nullable
Payment id.
aggregator_order_id
string
Payment order id.
method
string
Payment method.
success
boolean
Response is successful or not.
upi_poll_url
string
Nullable
UPI poll url.
virtual_id
string
Nullable
Payment virtual address.
device_id
string
Nullable
EDC machine Unique Identifier.
polling_url
string
Polling url.
aggregator
string
Payment gateway name.
merchant_order_id
string
Order id.
customer_id
string
Nullable
Payment gateway customer id.
vpa
string
Nullable
Customer vpa address.
currency
string
Nullable
Currency code.
timeout
integer
| int32
Nullable
Timeout.
amount
integer
| int32
Nullable
Payable amount.
bqr_image
string
Nullable
Bharat qr image url.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Initialize payment link
initialisePaymentPaymentLink
POST
Update payment link status
Verify and update status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required.
Parameters
body
object (PaymentStatusUpdateRequest)
Required
Check the example of a request body below or refer `PaymentStatusUpdateRequest` for more details.
PaymentStatusUpdateRequest
status
string
Status of payment.
merchant_transaction_id
string
Unique fynd transaction id.
method
string
Required
Payment method.
device_id
string
Nullable
EDC machine Unique Identifier.
aggregator
string
Required
Payment gateway name.
customer_id
string
Payment gateway customer id.
contact
string
Customer valid mobile number.
merchant_order_id
string
Required
Unique fynd order id.
vpa
string
Customer vpa address.
order_id
string
Payment gateway order id.
currency
string
Currency code.
amount
integer
| int32
Nullable
Payable amount.
email
string
| email
Customer valid email.
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.
PaymentStatusUpdateResponse
status
string
Payment status.
success
boolean
Nullable
Response is successful or not.
retry
boolean
Response is successful or not.
redirect_url
string
Nullable
Redirect url.
aggregator_name
string
Payment gateway name.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update payment link status
checkAndUpdatePaymentStatusPaymentLink
Refund
Refund is the process of reimbursing a customer for a previous purchase. This typically involves returning the money to the customer's bank account, walllet, UPI or any other payment methods in which customer wants refund after they have returned the purchased item or requested a reimbursement for a service. A bank account for refund with IFSC code verification and secure OTP-based addition is a feature that allows customers to securely add their bank account details for receiving refunds. This functionality includes verification of the bank account details, such as the IFSC code, to ensure accuracy and validity. Additionally, it employs an OTP (One-Time Password) authentication process to securely add the bank account information, enhancing the security of the refund process and protecting customer financial data.
Operations
GET
# Verify IFSC
GET
# Retrieve beneficiary details
POST
# Verify OTP for bank and add beneficiary
POST
# Add beneficiary for refund
POST
# Add refund account using OTP verification
POST
# Verify OTP for wallet
POST
# Set default beneficiary for refund
GET
Verify IFSC
Validate IFSC code and returns bank details if valid.
Parameters
ifscCode
string
A 11-digit alphanumeric code that uniquely identifies a bank branch.
Response
200
400
500
Success. Shows whether the IFSC code is valid, and returns the bank details. Check the example shown below or refer `IfscCodeResponse` for more details.
IfscCodeResponse
branch_name
string
Branch Name Of Account.
success
boolean
Response is successful or not.
bank_name
string
Bank Name Of Account.
Examples
Parameters
ifscCode:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Verify IFSC
verifyIfscCode
GET
Retrieve beneficiary details
Get beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing.
Parameters
orderId
string
Required
A unique number used for identifying and tracking your orders.
Response
200
400
500
Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.
OrderBeneficiaryResponse
show_beneficiary_details
boolean
Show beneficiary details or not.
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order.
Array of OrderBeneficiaryDetails
Examples
Parameters
orderId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieve beneficiary details
getOrderBeneficiariesDetail
POST
Verify OTP for bank and add beneficiary
Verify the OTP provided by the user and adds a bank beneficiary for refund processing.
Parameters
body
object (AddBeneficiaryViaOtpVerificationRequest)
Required
Pass the OTP, request ID and hash key in the request body as shown below.
AddBeneficiaryViaOtpVerificationRequest
request_id
string
Required
Request id.
hash_key
string
Required
Hash key of the beneficiary Id.
otp
string
Required
Otp sent to the given Mobile No.
Response
200
400
500
Success. Check the example shown below or refer `AddBeneficiaryViaOtpVerificationRequest` for more details.
AddBeneficiaryViaOtpVerificationResponse
success
boolean
Response is successful or not.
message
string
Aggregator Response of beneficiary.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify OTP for bank and add beneficiary
verifyOtpAndAddBeneficiaryForBank
POST
Add beneficiary for refund
Add beneficiary details specifically for refund transactions, including account holder name, account number and bank details.
Parameters
body
object (AddBeneficiaryDetailsRequest)
Required
Check the example of a request body below or refer `AddBeneficiaryDetailsRequest` for more details.
AddBeneficiaryDetailsRequest
delights
boolean
Required
True if beneficiary to be added by delights or False if by User.
shipment_id
string
Required
Shipment Id of the respective Merchant Order Id.
details
object (BeneficiaryModeDetails)
Required
BeneficiaryModeDetails
otp
string
OTP received by customer.
order_id
string
Required
Merchant Order Id.
transfer_mode
string
Required
Transfer Mode of the Beneficiary to be added.
request_id
string
Request Id for add benificiary request.
Response
200
400
500
Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
RefundAccountResponse
is_verified_flag
boolean
Flag for verification of refund.
data
object
Refund account data.
success
boolean
Success or failure flag.
message
string
Response message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Add beneficiary for refund
addBeneficiaryDetails
POST
Add refund account using OTP verification
Add bank account specifically for refunds, employing OTP verification for security.
Parameters
body
object (AddBeneficiaryDetailsOTPRequest)
Required
AddBeneficiaryDetailsOTPRequest
order_id
string
Required
Unique identifier for an order.
details
object (BankDetailsForOTP)
Required
BankDetailsForOTP
Response
200
400
500
Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
RefundAccountResponse
is_verified_flag
boolean
Flag for verification of refund.
data
object
Refund account data.
success
boolean
Success or failure flag.
message
string
Response message.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Add refund account using OTP verification
addRefundBankAccountUsingOTP
POST
Verify OTP for wallet
Verify OTP provided by the user and adds a wallet beneficiary.
Parameters
body
object (WalletOtpRequest)
Required
Pass mobile number and country code in the request body as shown below.
WalletOtpRequest
country_code
string
Required
Country Code of the Mobile Number.
mobile
string
Required
Wallet Mobile Number of the User.
Response
200
400
500
Success. Sends the OTP to the given mobile number. Check the example shown below or refer `WalletOtpResponse` for more details.
WalletOtpResponse
request_id
string
Request Id for wallet otp request.
is_verified_flag
string
Boolean Flag whether OTP Validation is already done or not.
success
boolean
Response is successful or not.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify OTP for wallet
verifyOtpAndAddBeneficiaryForWallet
POST
Set default beneficiary for refund
Update default beneficiary for the order refund of the user.
Parameters
body
object (SetDefaultBeneficiaryRequest)
Required
Pass the order ID and beneficiary ID in the request body as shown below.
SetDefaultBeneficiaryRequest
order_id
string
Required
Merchant Order Id.
beneficiary_id
string
Required
Beneficiary Hash Id of the beneficiary added.
Response
200
400
500
Success. Check the example shown below or refer `SetDefaultBeneficiaryResponse` for more details.
SetDefaultBeneficiaryResponse
is_beneficiary_set
boolean
Boolean Flag whether Beneficiary set or not.
success
boolean
Response is successful or not.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Set default beneficiary for refund
updateDefaultBeneficiary
Refund Transfer Modes
Refund transfer modes encompass various methods for processing refunds to customers, such as issuing store credit or vouchers for future purchases and providing refunds via digital payment platforms like Paytm or PhonePe.
Operations
GET
# Get refund transfer modes
PUT
# Toggle refund mode
GET
Get refund transfer modes
Lists available refund modes, such as UPI, providing details like display name, logo, and ID for each mode.
Parameters
No Parameters
Response
200
500
Success. Shows the available refund mode to choose, e.g. Netbanking. Check the example shown below or refer `TransferModeResponse` for more details.
TransferModeResponse
data
array of object (TransferModeDetails)
Response Object.
Array of TransferModeDetails
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get refund transfer modes
getActiveRefundTransferModes
PUT
Toggle refund mode
Enable/Disable a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled.
Parameters
body
object (UpdateRefundTransferModeRequest)
Required
Pass the refund transfer mode in the request body and whether to enable or disable it.
UpdateRefundTransferModeRequest
enable
boolean
Required
True for enabling the Transfer Mode.
transfer_mode
string
Required
Transfer Mode of the Beneficiary to be added.
Response
200
500
Success. Shows whether the refund mode was successfully enabled or disabled.
UpdateRefundTransferModeResponse
success
boolean
Response is successful or not.
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...