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

Get beneficiaries associated with the user for processing refunds, based on the provided order ID.
Parameters
order_id
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
modified_on
string
MOdification Date of Beneficiary.
account_no
string
Account Number.
mobile
string
MObile no of User.
bank_name
string
Bank Name Of Account.
ifsc_code
string
Ifsc Code Of Account.
is_active
boolean
Boolean Flag whether Beneficiary set or not.
beneficiary_id
string
Beneficiary Id.
account_holder
string
Account Holder Name.
email
string
EMail of User.
delights_user_name
string
Nullable
User Id Who filled the Beneficiary.
id
integer
| int32
Id of the Order Beneficiary.
transfer_mode
string
Transfer Mode Of Account.
branch_name
string
Branch Name Of Account.
created_on
string
Creation Date of Beneficiary.
subtitle
string
SHort Title Of Account.
comment
string
Remarks.
address
string
Address of User.
title
string
Title Of Account.
display_name
string
Display Name Of Account.
Examples
Parameters
order_id:
"value"
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

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
No Parameters
Request body
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
POST
/service/application/payment/v1.0/card/attach
Loading...
Response
Loading...
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
api
string
Nullable
Payment gateway CARD api endpoint.
aggregator
string
Payment gateway name.
customer_id
string
Nullable
Payment gateway customer id.
success
boolean
Response is successful or not.
message
string
Human readable message.
Examples
Parameters
refresh:
false
GET
/service/application/payment/v1.0/card/aggregator
Loading...
Response
Loading...
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
force_refresh
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
card_number
string
Nullable
Card number mentioned on the card.
card_name
string
Nullable
Name mentioned on the card.
card_type
string
Nullable
Type of the card.
card_brand_image
string
| url
Nullable
Brand image on the card.
card_reference
string
Nullable
Card reference.
card_issuer
string
Nullable
Issuer of the card.
card_brand
string
Nullable
Brand of the card.
expired
boolean
Nullable
Card expiry.
compliant_with_tokenisation_guidelines
boolean
Nullable
Whether card is tokenized or not.
card_isin
string
Nullable
International Securities Identification Number for the card.
exp_year
integer
| int32
Nullable
Card's expiration year.
nickname
string
Nullable
User-defined name for the card.
aggregator_name
string
Name of the payment aggregator.
card_fingerprint
string
Nullable
Unique fingerprint of the card for identification.
card_token
string
Nullable
Encrypted token representing the card.
exp_month
integer
| int32
Nullable
Card's expiration month.
card_id
string
Nullable
Unique identifier for the card within the system.
success
boolean
Response is successful or not.
message
string
Human readable message.
Examples
Parameters
force_refresh:
false
GET
/service/application/payment/v1.0/cards
Loading...
Response
Loading...
POST

Delete customer card

Delete payment card from the user's account.
Parameters
No Parameters
Request body
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
POST
/service/application/payment/v1.0/card/remove
Loading...
Response
Loading...
GET

Get card details

Get details of a specified payment card, including information such as the card type, brand, country, and expiration date.
Parameters
card_info
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
status
boolean
Current status of the card.
country
string
Country where the card was issued.
bank_code
string
Nullable
Code identifying the bank.
id
string
Unique identifier for the record.
card_exp_year
string
Card's expiration year.
card_brand
string
Brand of the card (e.g., Visa, MasterCard).
type
string
General type of the card (e.g., debit, credit).
card_sub_type
string
Nullable
Sub-type of the card (e.g., Platinum, Gold).
is_domestic_card
boolean
Indicates whether the card is domestic.
name_on_card
string
Name of the cardholder.
card_exp_month
string
Card's expiration month.
extended_card_type
string
Extended type of the card, providing more specific classification.
card_object
string
Object representation of the card.
card_token
string
Encrypted token representing the card.
user
string
User associated with the card.
bank
string
Bank associated with the card.
success
boolean
Response is successful or not.
Examples
Parameters
card_info:
"value"
aggregator:
"value"
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

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"
GET
/service/application/payment/v1.0/payment/outstanding-orders/
Loading...
Response
Loading...
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"
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
No Parameters
Request body
payment_methods
array of object (PaymentOrderMethods)
All payment methods for order.
Array of PaymentOrderMethods
amount
number
| float
Required
Amount to be collected.
payment
string
Payment type i.e. Required / Blocked.
mode
string
Required
Payment mode.
meta
object (PaymentMethodsMetaOrder)
Required
PaymentMethodsMetaOrder
merchant_code
string
Required
Merchant code.
payment_gateway
string
Required
Payment gateway name.
payment_identifier
string
Required
Payment identifier.
name
string
Required
Payment mode name.
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
amount
number
| float
Nullable
Amount.
aggregator
string
Nullable
Aggregator name.
callback_url
string
Nullable
Callback url for aggregator.
order_id
string
Nullable
Aggregator order id.
customer_id
string
Nullable
Aggregator customer id.
merchant_order_id
string
Nullable
Merchant order id.
currency
string
Nullable
Currency used for the order.
email
string
Nullable
Email address of the customer.
contact
string
Nullable
Contact number of the customer.
method
string
Nullable
Method of payment or delivery for the order.
message
string
Detailed message.
Examples
Parameters
body:
body
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 if the user is eligible for pay-later payment from the payment aggregator side using the customer's phone number.
Parameters
No Parameters
Request body
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.
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
No Parameters
Request body
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
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

Get aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway.
Parameters
refresh
boolean
Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
Headers
x-api-token
string
Basic auth token.
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
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
juspay
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
simpl
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
payumoney
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
rupifi
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
mswipe
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
stripe
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
ccavenue
object (AggregatorConfigDetail)
AggregatorConfigDetail
sdk
boolean
Nullable
SDK details.
secret
string
Masked payment gateway api secret.
api
string
| url
Nullable
Payment gateway api endpoint.
pin
string
Nullable
Masked pin.
config_type
string
Fynd or self payment gateway.
merchant_key
string
Nullable
Unique merchant key.
verify_api
string
| url
Nullable
Payment gateway verify payment api endpoint.
key
string
Payment gateway api key.
user_id
string
Nullable
Registered User id.
merchant_id
string
Nullable
Unique merchant id.
env
string
Environment i.e Live or Test.
Examples
Parameters
refresh:
false
x-api-token:
"value"
GET
/service/application/payment/v1.0/config/aggregators/key
Loading...
Response
Loading...
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
No Parameters
Request body
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
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
No Parameters
Request body
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
POST
/service/application/payment/v1.0/payment/confirm/polling
Loading...
Response
Loading...
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.
cart_id
string
Identifier of the cart.
checkout_mode
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.
order_id
string
Identifier of the order, order_id.
card_reference
string
Card reference id of user's debit or credit card.
user_details
string
URLencoded JSON containing details of an anonymous user.
display_split
boolean
Display Split Payment Option or not.
advance_payment
boolean
Display Advance Payment Options or Normal.
shipment_id
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
payment_option
array of object (RootPaymentMode)
Payment options.
Array of RootPaymentMode
is_pay_by_card_pl
boolean
Nullable
This flag will be true in case of Payment link payment through card.
add_card_enabled
boolean
Nullable
Anonymous card flag.
display_priority
integer
| int32
Display Priority.
display_name
string
Payment mode display name.
list
array of object (PaymentModeList)
Payment mode.
Array of PaymentModeList
card_number
string
Nullable
Card number mentioned on the card.
merchant_code
string
Nullable
Unique code identifying the merchant.
card_reference
string
Nullable
Reference identifier for the card.
card_issuer
string
Nullable
Issuing bank or institution of the card.
compliant_with_tokenisation_guidelines
boolean
Nullable
Indicates compliance with tokenization guidelines.
code
string
Nullable
General code for identifying a transaction or status.
cod_limit
number
Nullable
Limit for Cash on Delivery (COD) transactions.
intent_flow
boolean
Nullable
Flow or process intended for the transaction.
fynd_vpa
string
Nullable
Virtual Payment Address (VPA) used by Fynd.
intent_app_error_dict_list
array of object (IntentAppErrorList)
Nullable
List of error dictionaries related to intent app.
Array of IntentAppErrorList
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
aggregator_name
string
Name of the payment aggregator.
card_fingerprint
string
Nullable
Unique fingerprint of the card for identification.
intent_app_error_list
array of string
Nullable
List of errors associated with the intent app.
intent_app
array of object (IntentApp)
Nullable
Application intended for handling the transaction.
Array of IntentApp
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
display_name
string
Nullable
Display Name of the intent App.
expired
boolean
Nullable
Indicates whether the card is expired.
retry_count
integer
| int32
Nullable
Number of retry attempts.
exp_year
integer
| int32
Nullable
Card's expiration year.
exp_month
integer
| int32
Nullable
Card's expiration month.
card_id
string
Nullable
Unique identifier for the card within the system.
remaining_limit
number
Nullable
Remaining available limit on the card.
display_priority
integer
| int32
Nullable
Priority of display in the user interface.
card_brand
string
Nullable
Brand of the card (e.g., Visa, MasterCard).
cod_limit_per_order
number
Nullable
Maximum limit per order for COD transactions.
logo_url
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
nickname
string
Nullable
User-defined name for the card.
card_name
string
Nullable
Name printed on the card.
card_type
string
Nullable
Type of the card (e.g., debit, credit).
card_brand_image
string
| url
Nullable
Image representing the card brand.
display_name
string
Nullable
Display name for the card in the user interface.
card_isin
string
Nullable
International Securities Identification Number for the card.
timeout
integer
| int32
Nullable
Timeout duration for transactions.
card_token
string
Nullable
Encrypted token representing the card.
name
string
Nullable
User's name.
meta
object
Nullable
Payment methods meta.
save_card
boolean
Nullable
Card save or not.
aggregator_name
string
Nullable
Display Priority.
name
string
Payment mode name.
anonymous_enable
boolean
Nullable
Anonymous card flag.
payment_flows
object (PaymentFlow)
PaymentFlow
bqr_razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
fynd
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
epaylater
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
juspay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
ajiodhan
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
simpl
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
rupifi
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
mswipe
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
stripe
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
ccavenue
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
payubiz
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
jiopay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
upi_razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
payment_default_selection
object (PaymentDefaultSelection)
PaymentDefaultSelection
mode
string
Nullable
Default Selection Payment Mode.
identifier
string
Nullable
Identifier for Payment Mode.
skip
boolean
Nullable
Decide if the default payment mode will skip the payment options page altogether or just be preferred on the Frontend.
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
name
string
Nullable
Name of Advance Payment Mode.
display_priority
number
| integer
Nullable
Display Priority for Payment Option.
payment_mode_id
number
| integer
Nullable
Payment Mode ID for Advance Payment Option.
display_name
string
Nullable
Display name for Advance Payment Mode.
list
array of object (PaymentModeList)
Nullable
Payment mode.
Array of PaymentModeList
card_number
string
Nullable
Card number mentioned on the card.
merchant_code
string
Nullable
Unique code identifying the merchant.
card_reference
string
Nullable
Reference identifier for the card.
card_issuer
string
Nullable
Issuing bank or institution of the card.
compliant_with_tokenisation_guidelines
boolean
Nullable
Indicates compliance with tokenization guidelines.
code
string
Nullable
General code for identifying a transaction or status.
cod_limit
number
Nullable
Limit for Cash on Delivery (COD) transactions.
intent_flow
boolean
Nullable
Flow or process intended for the transaction.
fynd_vpa
string
Nullable
Virtual Payment Address (VPA) used by Fynd.
intent_app_error_dict_list
array of object (IntentAppErrorList)
Nullable
List of error dictionaries related to intent app.
Array of IntentAppErrorList
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
aggregator_name
string
Name of the payment aggregator.
card_fingerprint
string
Nullable
Unique fingerprint of the card for identification.
intent_app_error_list
array of string
Nullable
List of errors associated with the intent app.
intent_app
array of object (IntentApp)
Nullable
Application intended for handling the transaction.
Array of IntentApp
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
display_name
string
Nullable
Display Name of the intent App.
expired
boolean
Nullable
Indicates whether the card is expired.
retry_count
integer
| int32
Nullable
Number of retry attempts.
exp_year
integer
| int32
Nullable
Card's expiration year.
exp_month
integer
| int32
Nullable
Card's expiration month.
card_id
string
Nullable
Unique identifier for the card within the system.
remaining_limit
number
Nullable
Remaining available limit on the card.
display_priority
integer
| int32
Nullable
Priority of display in the user interface.
card_brand
string
Nullable
Brand of the card (e.g., Visa, MasterCard).
cod_limit_per_order
number
Nullable
Maximum limit per order for COD transactions.
logo_url
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
nickname
string
Nullable
User-defined name for the card.
card_name
string
Nullable
Name printed on the card.
card_type
string
Nullable
Type of the card (e.g., debit, credit).
card_brand_image
string
| url
Nullable
Image representing the card brand.
display_name
string
Nullable
Display name for the card in the user interface.
card_isin
string
Nullable
International Securities Identification Number for the card.
timeout
integer
| int32
Nullable
Timeout duration for transactions.
card_token
string
Nullable
Encrypted token representing the card.
name
string
Nullable
User's name.
meta
object
Nullable
Payment methods meta.
split
object (SplitObject)
Nullable
SplitObject
total_number_of_splits
number
| integer
Nullable
Maximum amount of splits allowed.
splits_remaining
number
| integer
Nullable
Number of splits remaining.
amount_remaining
number
| float
Nullable
Amount pending to be paid.
advance
object (AdvanceObject)
Nullable
AdvanceObject
is_active
boolean
Nullable
Is Advance Payment active.
amount
number
| float
Amount for Payment Breakdown.
time_unit
string
Nullable
Time unit for refunds.
description
string
Nullable
The description for Advance Payment (user configured).
display_name
string
Nullable
The display name for Advance payment.
prepayment_type
string
Nullable
Type of prepayment value.
prepayment_value
number
| float
Nullable
Value for prepayment in advance payment.
cancellation_type
string
Nullable
Type of cancellation.
refund_time_limit
number
| float
Nullable
Time limit for processing refund.
all_prepayment_type
array of string
Nullable
All available types of prepayment.
allow_custom_advance_amount
boolean
Nullable
Is custom advance amount allowed?.
Examples
Parameters
amount:
1
cart_id:
"value"
checkout_mode:
"value"
refresh:
false
order_id:
"value"
card_reference:
"value"
user_details:
"value"
display_split:
false
advance_payment:
false
shipment_id:
"value"
GET
/service/application/payment/v1.0/payment/options
Loading...
Response
Loading...
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.
cart_id
string
Identifier of the cart.
pincode
string
Required
The PIN Code of the destination address, e.g. 400059.
checkout_mode
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.
card_reference
string
Card reference id of user's debit or credit card.
order_type
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.
user_details
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
payment_option
array of object (RootPaymentMode)
Payment options.
Array of RootPaymentMode
is_pay_by_card_pl
boolean
Nullable
This flag will be true in case of Payment link payment through card.
add_card_enabled
boolean
Nullable
Anonymous card flag.
display_priority
integer
| int32
Display Priority.
display_name
string
Payment mode display name.
list
array of object (PaymentModeList)
Payment mode.
Array of PaymentModeList
card_number
string
Nullable
Card number mentioned on the card.
merchant_code
string
Nullable
Unique code identifying the merchant.
card_reference
string
Nullable
Reference identifier for the card.
card_issuer
string
Nullable
Issuing bank or institution of the card.
compliant_with_tokenisation_guidelines
boolean
Nullable
Indicates compliance with tokenization guidelines.
code
string
Nullable
General code for identifying a transaction or status.
cod_limit
number
Nullable
Limit for Cash on Delivery (COD) transactions.
intent_flow
boolean
Nullable
Flow or process intended for the transaction.
fynd_vpa
string
Nullable
Virtual Payment Address (VPA) used by Fynd.
intent_app_error_dict_list
array of object (IntentAppErrorList)
Nullable
List of error dictionaries related to intent app.
Array of IntentAppErrorList
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
aggregator_name
string
Name of the payment aggregator.
card_fingerprint
string
Nullable
Unique fingerprint of the card for identification.
intent_app_error_list
array of string
Nullable
List of errors associated with the intent app.
intent_app
array of object (IntentApp)
Nullable
Application intended for handling the transaction.
Array of IntentApp
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
display_name
string
Nullable
Display Name of the intent App.
expired
boolean
Nullable
Indicates whether the card is expired.
retry_count
integer
| int32
Nullable
Number of retry attempts.
exp_year
integer
| int32
Nullable
Card's expiration year.
exp_month
integer
| int32
Nullable
Card's expiration month.
card_id
string
Nullable
Unique identifier for the card within the system.
remaining_limit
number
Nullable
Remaining available limit on the card.
display_priority
integer
| int32
Nullable
Priority of display in the user interface.
card_brand
string
Nullable
Brand of the card (e.g., Visa, MasterCard).
cod_limit_per_order
number
Nullable
Maximum limit per order for COD transactions.
logo_url
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
nickname
string
Nullable
User-defined name for the card.
card_name
string
Nullable
Name printed on the card.
card_type
string
Nullable
Type of the card (e.g., debit, credit).
card_brand_image
string
| url
Nullable
Image representing the card brand.
display_name
string
Nullable
Display name for the card in the user interface.
card_isin
string
Nullable
International Securities Identification Number for the card.
timeout
integer
| int32
Nullable
Timeout duration for transactions.
card_token
string
Nullable
Encrypted token representing the card.
name
string
Nullable
User's name.
meta
object
Nullable
Payment methods meta.
save_card
boolean
Nullable
Card save or not.
aggregator_name
string
Nullable
Display Priority.
name
string
Payment mode name.
anonymous_enable
boolean
Nullable
Anonymous card flag.
payment_flows
object (PaymentFlow)
PaymentFlow
bqr_razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
fynd
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
epaylater
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
juspay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
ajiodhan
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
simpl
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
rupifi
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
mswipe
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
stripe
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
ccavenue
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
payubiz
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
jiopay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
upi_razorpay
object (AggregatorRoute)
AggregatorRoute
data
object
Nullable
Details about aggregator route.
payment_flow_data
object
Nullable
Payment_flow_data.
payment_flow
string
Nullable
Payment_flow.
api_link
string
| url
Nullable
API link of the aggregator.
payment_default_selection
object (PaymentDefaultSelection)
PaymentDefaultSelection
mode
string
Nullable
Default Selection Payment Mode.
identifier
string
Nullable
Identifier for Payment Mode.
skip
boolean
Nullable
Decide if the default payment mode will skip the payment options page altogether or just be preferred on the Frontend.
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
name
string
Nullable
Name of Advance Payment Mode.
display_priority
number
| integer
Nullable
Display Priority for Payment Option.
payment_mode_id
number
| integer
Nullable
Payment Mode ID for Advance Payment Option.
display_name
string
Nullable
Display name for Advance Payment Mode.
list
array of object (PaymentModeList)
Nullable
Payment mode.
Array of PaymentModeList
card_number
string
Nullable
Card number mentioned on the card.
merchant_code
string
Nullable
Unique code identifying the merchant.
card_reference
string
Nullable
Reference identifier for the card.
card_issuer
string
Nullable
Issuing bank or institution of the card.
compliant_with_tokenisation_guidelines
boolean
Nullable
Indicates compliance with tokenization guidelines.
code
string
Nullable
General code for identifying a transaction or status.
cod_limit
number
Nullable
Limit for Cash on Delivery (COD) transactions.
intent_flow
boolean
Nullable
Flow or process intended for the transaction.
fynd_vpa
string
Nullable
Virtual Payment Address (VPA) used by Fynd.
intent_app_error_dict_list
array of object (IntentAppErrorList)
Nullable
List of error dictionaries related to intent app.
Array of IntentAppErrorList
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
aggregator_name
string
Name of the payment aggregator.
card_fingerprint
string
Nullable
Unique fingerprint of the card for identification.
intent_app_error_list
array of string
Nullable
List of errors associated with the intent app.
intent_app
array of object (IntentApp)
Nullable
Application intended for handling the transaction.
Array of IntentApp
code
string
Nullable
Code of the intent App.
package_name
string
Nullable
Package Name of the intent App.
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
display_name
string
Nullable
Display Name of the intent App.
expired
boolean
Nullable
Indicates whether the card is expired.
retry_count
integer
| int32
Nullable
Number of retry attempts.
exp_year
integer
| int32
Nullable
Card's expiration year.
exp_month
integer
| int32
Nullable
Card's expiration month.
card_id
string
Nullable
Unique identifier for the card within the system.
remaining_limit
number
Nullable
Remaining available limit on the card.
display_priority
integer
| int32
Nullable
Priority of display in the user interface.
card_brand
string
Nullable
Brand of the card (e.g., Visa, MasterCard).
cod_limit_per_order
number
Nullable
Maximum limit per order for COD transactions.
logo_url
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Large Logo.
small
string
| url
Small Logo.
nickname
string
Nullable
User-defined name for the card.
card_name
string
Nullable
Name printed on the card.
card_type
string
Nullable
Type of the card (e.g., debit, credit).
card_brand_image
string
| url
Nullable
Image representing the card brand.
display_name
string
Nullable
Display name for the card in the user interface.
card_isin
string
Nullable
International Securities Identification Number for the card.
timeout
integer
| int32
Nullable
Timeout duration for transactions.
card_token
string
Nullable
Encrypted token representing the card.
name
string
Nullable
User's name.
meta
object
Nullable
Payment methods meta.
split
object (SplitObject)
Nullable
SplitObject
total_number_of_splits
number
| integer
Nullable
Maximum amount of splits allowed.
splits_remaining
number
| integer
Nullable
Number of splits remaining.
amount_remaining
number
| float
Nullable
Amount pending to be paid.
advance
object (AdvanceObject)
Nullable
AdvanceObject
is_active
boolean
Nullable
Is Advance Payment active.
amount
number
| float
Amount for Payment Breakdown.
time_unit
string
Nullable
Time unit for refunds.
description
string
Nullable
The description for Advance Payment (user configured).
display_name
string
Nullable
The display name for Advance payment.
prepayment_type
string
Nullable
Type of prepayment value.
prepayment_value
number
| float
Nullable
Value for prepayment in advance payment.
cancellation_type
string
Nullable
Type of cancellation.
refund_time_limit
number
| float
Nullable
Time limit for processing refund.
all_prepayment_type
array of string
Nullable
All available types of prepayment.
allow_custom_advance_amount
boolean
Nullable
Is custom advance amount allowed?.
Examples
Parameters
amount:
1
cart_id:
"value"
pincode:
"value"
checkout_mode:
"value"
refresh:
false
card_reference:
"value"
order_type:
"value"
user_details:
"value"
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
No Parameters
Request body
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.
POST
/service/application/payment/v1.0/payment/options/wallet/link
Loading...
Response
Loading...
POST

OTP verification

Verify the linking of wallet using OTP for further processing of payment.
Parameters
No Parameters
Request body
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.
POST
/service/application/payment/v1.0/payment/options/wallet/verify
Loading...
Response
Loading...
POST

Delink the wallet

Delink the wallet.
Parameters
No Parameters
Request body
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.
POST
/service/application/payment/v1.0/payment/options/wallet/delink
Loading...
Response
Loading...
POST

Render HTML

Render HTML for a payment aggregator page.
Parameters
No Parameters
Request body
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
POST
/service/application/payment/v1.0/payment/html/render/
Loading...
Response
Loading...
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
No Parameters
Request body
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
status
string
VALID or INVALID.
customer_name
string
Customer Bank.
is_valid
boolean
Boolean is true or false.
upi_vpa
string
UPI ID.
success
boolean
Response is successful or not.
Examples
Parameters
body:
body
POST
/service/application/payment/v1.0/validate-vpa
Loading...
Response
Loading...
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
total_due_amount
object (BalanceDetails)
BalanceDetails
formatted_value
string
Nullable
Formatted Amount with currency symbol.
currency
string
Nullable
Currency Code.
value
number
| float
Nullable
Payment amount.
status
string
Nullable
Customer Credit status.
limit
object (BalanceDetails)
BalanceDetails
formatted_value
string
Nullable
Formatted Amount with currency symbol.
currency
string
Nullable
Currency Code.
value
number
| float
Nullable
Payment amount.
credit_line_id
string
Nullable
ID at Credit aggregator end.
amount_available
object (BalanceDetails)
BalanceDetails
formatted_value
string
Nullable
Formatted Amount with currency symbol.
currency
string
Nullable
Currency Code.
value
number
| float
Nullable
Payment amount.
due_amount
object (BalanceDetails)
BalanceDetails
formatted_value
string
Nullable
Formatted Amount with currency symbol.
currency
string
Nullable
Currency Code.
value
number
| float
Nullable
Payment amount.
due_date
string
Nullable
Due date for repayment.
balance
object (BalanceDetails)
BalanceDetails
formatted_value
string
Nullable
Formatted Amount with currency symbol.
currency
string
Nullable
Currency Code.
value
number
| float
Nullable
Payment amount.
status_message
string
Nullable
Message to customer.
repayment_url
string
Nullable
Url for repayment.
soa_url
string
Nullable
Statement of accounts. Show payment history.
is_eligible_for_txn
boolean
Nullable
Eligibility flag to complete transaction.
merchant_customer_ref_id
string
Nullable
Unique aggregator customer id.
buyer_status
string
Nullable
Status from Credit aggregator end.
activation_url
string
Nullable
Url for activation.
success
boolean
Payment confirmation updated or not.
Examples
Parameters