Skip to main content

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
/service/application/payment/v1.0/refund/user/beneficiary
# Retrieve beneficiary details
GET

Retrieve beneficiary details

Retrieves information about 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
/service/application/payment/v1.0/refund/user/beneficiary
Loading...
Response
Loading...

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
/service/application/payment/v1.0/card/attach
# Link payment card to customer
GET
/service/application/payment/v1.0/card/aggregator
# Retrieve active card aggregator
GET
/service/application/payment/v1.0/cards
# Get customer cards
POST
/service/application/payment/v1.0/card/remove
# Delete customer card
GET
/service/application/payment/v1.0/cards/info/{card_info}
# Get card details
POST

Link payment card to customer

Linking of a payment card to a user's 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
Default Value :
refresh
boolean
Nullable
Refresh cache flag.
card_id
string
Nullable
Required
Card token of payment gateway.
name_on_card
string
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
/service/application/payment/v1.0/card/attach
Loading...
Response
Loading...
GET

Retrieve active card aggregator

Fetches 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
refresh
boolean
This is a boolean value. 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
/service/application/payment/v1.0/card/aggregator
Loading...
Response
Loading...
GET

Get customer cards

Retrieves a list of 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
This is a boolean value. 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
/service/application/payment/v1.0/cards
Loading...
Response
Loading...
POST

Delete customer card

Deletion of a 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
/service/application/payment/v1.0/card/remove
Loading...
Response
Loading...
GET

Get card details

Fetches the 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 decribing 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
/service/application/payment/v1.0/cards/info/{card_info}
Loading...
Response
Loading...

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
/service/application/payment/v1.0/payment/outstanding-orders/
# Outstanding orders
GET
/service/application/payment/v1.0/payment/paid-orders/
# Retrieve details of paid orders
POST
/service/application/payment/v1.0/payment-orders/
# Create Order
GET

Outstanding orders

Retrieve details of orders with outstanding payments.
Parameters
aggregator
string
This is a String value that contains 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
/service/application/payment/v1.0/payment/outstanding-orders/
Loading...
Response
Loading...
GET

Retrieve details of paid orders

Retrieves 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's merchant user ID.
Parameters
aggregator
string
This is a String value that contains 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
/service/application/payment/v1.0/payment/paid-orders/
Loading...
Response
Loading...
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)
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
Message
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/payment-orders/
Loading...
Response
Loading...

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
/service/application/payment/v1.0/payment/customer/validation
# Verify payment customer
POST
/service/application/payment/v1.0/payment/confirm/charge
# Verify order confirmation and charge
POST

Verify payment customer

Verify whether the user is eligible for pay-later payment from the payment aggregator's 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 camel case i.e Simpl, 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
/service/application/payment/v1.0/payment/customer/validation
Loading...
Response
Loading...
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
Chargable 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 adddress id of customer
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/payment/confirm/charge
Loading...
Response
Loading...

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
/service/application/payment/v1.0/config/aggregators/key
# Get payment aggregators
POST
/service/application/payment/v1.0/payment/request
# Start payment process
POST
/service/application/payment/v1.0/payment/confirm/polling
# Update payment status
GET
/service/application/payment/v1.0/payment/options
# Get payment modes
GET
/service/application/payment/v1.0/payment/options/pos
# POS payment modes
POST
/service/application/payment/v1.0/payment/options/wallet/link
# Initiate linking of wallet
POST
/service/application/payment/v1.0/payment/options/wallet/verify
# OTP verification
POST
/service/application/payment/v1.0/payment/options/wallet/delink
# Delink the wallet
POST
/service/application/payment/v1.0/payment/html/render/
# Render HTML
POST
/service/application/payment/v1.0/validate-vpa
# Validate VPA
GET
/service/application/payment/v1.0/payment/credit-summary/
# Credit summary
GET
/service/application/payment/v1.0/payment/redirect-to-aggregator/
# Redirects users to the payment aggregator's interface
GET
/service/application/payment/v1.0/check-credits/
# Verify credit availability and status
POST
/service/application/payment/v1.0/credit-onboard/
# Onboard customer for payment
GET

Get payment aggregators

Retrieve the aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway
Parameters
xApiToken
string
Used for basic authentication.
refresh
boolean
This is a boolean value. 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
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
/service/application/payment/v1.0/config/aggregators/key
Loading...
Response
Loading...
POST

Start payment process

Initiates 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 recieved 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
Bharath qr image url.
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/payment/request
Loading...
Response
Loading...
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
/service/application/payment/v1.0/payment/confirm/polling
Loading...
Response
Loading...
GET

Get payment modes

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
This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
orderId
string
cardReference
string
Card reference id of user's debit or credit card.
userDetails
string
URIencoded 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
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
/service/application/payment/v1.0/payment/options
Loading...
Response
Loading...
GET

POS payment modes

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
This is a boolean value. 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
URIencoded 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
/service/application/payment/v1.0/payment/options/pos
Loading...
Response
Loading...
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
/service/application/payment/v1.0/payment/options/wallet/link
Loading...
Response
Loading...
POST

OTP verification

Verifies 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
/service/application/payment/v1.0/payment/options/wallet/verify
Loading...
Response
Loading...
POST

Delink the wallet

User removes already linked 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
/service/application/payment/v1.0/payment/options/wallet/delink
Loading...
Response
Loading...
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
/service/application/payment/v1.0/payment/html/render/
Loading...
Response
Loading...
POST

Validate VPA

Checks whether 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
/service/application/payment/v1.0/validate-vpa
Loading...
Response
Loading...
GET

Credit summary

Fetches a 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
This is a String value that contains aggregator name as value.
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
/service/application/payment/v1.0/payment/credit-summary/
Loading...
Response
Loading...
GET

Redirects users to the payment aggregator's interface

Redirects users to the payment aggregator's interface and provides necessary parameters such as the callback URL and aggregator name. Returns the status of the payment along with the redirect URL and signup URL.
Parameters
source
string
This is a String value that contains callback URL as value.
aggregator
string
This is a String value that contains aggregator name as value.
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
/service/application/payment/v1.0/payment/redirect-to-aggregator/
Loading...
Response
Loading...
GET

Verify credit availability and status

Checks 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
This is a String value that contains aggregator name as value.
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
/service/application/payment/v1.0/check-credits/
Loading...
Response
Loading...
POST

Onboard customer for payment

Initiates 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
Mcc
aggregator
string
Required
Aggregator Name
marketplace_info
object (MarketplaceInfo)
MarketplaceInfo
source
string
| url
Required
callbackURL
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
/service/application/payment/v1.0/credit-onboard/
Loading...
Response
Loading...

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
/service/application/payment/v1.0/ifsc-code/verify
# Verify IFSC
GET
/service/application/payment/v1.0/refund/order/beneficiaries
# Retrieve beneficiary details
POST
/service/application/payment/v1.0/refund/verification/bank
# Verify OTP for bank and add beneficiary
POST
/service/application/payment/v1.0/refund/account
# Add beneficiary for refund
POST
/service/application/payment/v1.0/refund/account/otp
# Add refund account using OTP verification
POST
/service/application/payment/v1.0/refund/verification/wallet
# Verify OTP for wallet
POST
/service/application/payment/v1.0/refund/beneficiary/default
# Set default beneficiary for refund
GET

Verify IFSC

Checks the validity of the provided 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
/service/application/payment/v1.0/ifsc-code/verify
Loading...
Response
Loading...
GET

Retrieve beneficiary details

Retrieve 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
/service/application/payment/v1.0/refund/order/beneficiaries
Loading...
Response
Loading...
POST

Verify OTP for bank and add beneficiary

This endpoint confirms 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 sent in
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 beneficicary
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/refund/verification/bank
Loading...
Response
Loading...
POST

Add beneficiary for refund

Adds 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
order_id
string
Required
Merchant Order Id
transfer_mode
string
Required
Transfer Mode of the Beneficiary to be added
request_id
string
Response
200
400
500
Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
RefundAccountResponse
is_verified_flag
boolean
data
object
Refund account data.
success
boolean
Success or failure flag.
message
string
Response message
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/refund/account
Loading...
Response
Loading...
POST

Add refund account using OTP verification

The addition of a bank account specifically for refunds, employing OTP verification for security
Parameters
body
object (AddBeneficiaryDetailsOTPRequest)
Required
AddBeneficiaryDetailsOTPRequest
order_id
string
Required
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
data
object
Refund account data.
success
boolean
Success or failure flag.
message
string
Response message
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/payment/v1.0/refund/account/otp
Loading...
Response
Loading...
POST

Verify OTP for wallet

Confirm 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 Moblie 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
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
/service/application/payment/v1.0/refund/verification/wallet
Loading...
Response
Loading...
POST

Set default beneficiary for refund

Updates the 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
/service/application/payment/v1.0/refund/beneficiary/default
Loading...
Response
Loading...

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
/service/application/payment/v1.0/refund/transfer-mode
# Get refund transfer modes
PUT
/service/application/payment/v1.0/refund/transfer-mode
# Toggle refund mode
GET

Get refund transfer modes

Lists the 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
/service/application/payment/v1.0/refund/transfer-mode
Loading...
Response
Loading...
PUT

Toggle refund mode

Enables or disables 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
/service/application/payment/v1.0/refund/transfer-mode
Loading...
Response
Loading...