Payment

Collect payment through many payment gateway i.e Stripe, Razorpay, Juspay etc.into Fynd or Self account

Aggregator

Aggregator Configuration involves the setup and customization of payment aggregation services provided by a payment aggregator. A payment aggregator is a service provider that consolidates payment processing for multiple merchants through a single seller account. Aggregator configuration includes settings related to payment processing, security protocols, transaction fees, currency conversion, reporting, and other parameters. Sellers configure their aggregator accounts to tailor the payment processing experience to their specific requirements, ensuring seamless and secure transactions for their customers.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential/history
# Get merchant refund priority
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential
# API to get merchant refund priority
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential
# Update Aggregator Credentials
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/copy-config
# Copy aggregator config of onc device to another.
GET

Get merchant refund priority

Get merchant refund priority.
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
aggregator
string
Required
The aggregator for which credentials are requested
config_type
string
Required
The configuration type for which credentials are requested
Response
200
Successful response
AggregatorHistoryDetails
success
boolean
items
array of object (HistoryItem)
Array of HistoryItem
created_on
string
updated_on
string
reviewer
string
comments
string
review_status
string
is_active
boolean
config_type
string
public_token
string
razorpay_account_id
string
key
string
secret
string
webhook_secret
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
aggregator:
"razorpay"
config_type:
"self"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential/history
Loading...
Response
Loading...
GET

API to get merchant refund priority

API to get merchant refund priority
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
aggregator
string
Required
The aggregator for which credentials are requested
config_type
string
Required
The configuration type for which credentials are requested
Response
200
Successful response
AggregatorCredentialRes
success
boolean
created
boolean
app_id
string
excluded_fields
array of string
display_fields
array of string
aggregators
array of object (AggregatorCredential)
Array of AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
aggregator:
"razorpay"
config_type:
"self"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential
Loading...
Response
Loading...
POST

Update Aggregator Credentials

Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
success
boolean
ccavenue
object (AggregatorCredential)
AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
juspay
object (AggregatorCredential)
AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
razorpay
object (AggregatorCredential)
AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
potlee
object (AggregatorCredential)
AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
jio
object (AggregatorCredential)
AggregatorCredential
key
string
secret
string
merchant_id
string
is_active
boolean
config_type
string
display
object (AggregatorDisplayItem)
AggregatorDisplayItem
info
array of string
Nullable
link
string
text
string
description
string
Nullable
review_status
string
aggregator
string
logo
string
display_name
string
integration_type
string
is_active
boolean
app_id
string
Response
200
Successful response
PatchAggregatorCredentialDetails
success
boolean
aggregators
array of string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential
Loading...
Response
Loading...
PATCH

Copy aggregator config of onc device to another.

Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
aggregator_id
string
Required
Aggregator Id
Request body
from_config
object (FromConfig)
Required
FromConfig
device
string
Required
Device name
business_unit
string
Required
Business unit name
to_config
object (ToConfig)
Required
ToConfig
device
array of string
Required
business_unit
string
Required
Business unit name
Response
200
400
Enable/Disable the aggregator and return updated response.
AggregatorConfigDetails
success
boolean
message
string
items
array of object (PaymentOptionItem)
Array of PaymentOptionItem
id
integer
name
string
priority
integer
display_name
string
slug
string
integration_type
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
is_active
boolean
config
array of string
payment_modes
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
payment_mode
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
checkout_type
string
country
array of string
currency
array of string
status
string
save_allowed
boolean
Indicates if saving is allowed.
extension_id
string
Nullable
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
aggregator_id:
"2"
body:
body
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/copy-config
Loading...
Response
Loading...

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/platform/payment/v2.0/company/{company_id}/application/{application_id}/refund/user/beneficiary
# Lists the beneficiary of a refund
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/validate/beneficiary-address
# Validate UPI ID and IFSC code
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/beneficiary/default
# Set a default beneficiary for a refund
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refunds/beneficiary-details/{shipment_id}
# get beneficiary details
GET

Lists the beneficiary of a refund

get the details of all active beneficiary added by a user for refund.
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
order_id
string
A unique number used for identifying and tracking your orders.
shipment_id
string
A unique number used for identifying and tracking your orders.
mop
string
Mode of payment for which beneficiary data required
Response
200
400
Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.
OrderBeneficiaryResponseSchemaV2
show_beneficiary_details
boolean
Show Beneficiary details on UI or not.
data
object (BeneficiaryRefundOptions)
Beneficiary Data for Bank account, UPI and Wallets.
BeneficiaryRefundOptions
bank
array of object (OrderBeneficiaryDetails)
List of all add bank beneficiary details.
Array of OrderBeneficiaryDetails
subtitle
string
SHort Title Of Account
id
integer
| int32
title
string
Title Of Account
account_holder
string
Account Holder Name
ifsc_code
string
Ifsc Code Of Account
comment
string
Remarks
created_on
string
Creation Date of Beneficiary
display_name
string
Display Name Of Account
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
transfer_mode
string
Transfer Mode Of Account
email
string
Email of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
branch_name
string
Branch Name Of Account
address
string
Address of User
modified_on
string
Modification Date of Beneficiary
beneficiary_id
string
Benenficiary Id
aggregator_id
integer
Nullable
is_verified
boolean
Nullable
status
string
Nullable
txn_id
string
Nullable
meta
object
Nullable
bank_name
string
account_no
string
mobile
string
Nullable
default_beneficiary
boolean
Nullable
wallet
object (WalletBeneficiaryDetails)
List of all add Wallet beneficiary details.
WalletBeneficiaryDetails
beneficiary_id
string
Benenficiary Id
modified_on
string
MOdification Date of Beneficiary
display_name
string
Display Name Of Account
id
integer
| int32
subtitle
string
SHort Title Of Account
transfer_mode
string
Transfer Mode Of Account
mobile
string
MObile no of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
created_on
string
Creation Date of Beneficiary
address
string
Address of User
title
string
Title Of Account
wallet_address
string
Bank Name Of Account
comment
string
Remarks
wallet
string
Branch Name Of Account
email
string
EMail of User
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
upi
object (UpiBeneficiaryDetails)
List of all add UPI beneficiary details.
UpiBeneficiaryDetails
beneficiary_id
string
Benenficiary Id
modified_on
string
MOdification Date of Beneficiary
display_name
string
Display Name Of Account
id
integer
| int32
subtitle
string
SHort Title Of Account
transfer_mode
string
Transfer Mode Of Account
vpa
string
Branch Name Of Account
mobile
string
Mobile no of User
vpa_address
string
Bank Name Of Account
created_on
string
Creation Date of Beneficiary
address
string
Address of User
title
string
Title Of Account
comment
string
Remarks
is_active
boolean
Boolean Flag whether Beneficiary set or not
email
string
EMail of User
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
limit
object (RefundOptionsLimit)
RefundOptionsLimit
bank
integer
wallet
integer
upi
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
order_id:
"FY65C2797B2F00FCF07E"
GET
/service/platform/payment/v2.0/company/{company_id}/application/{application_id}/refund/user/beneficiary
Loading...
Response
Loading...
POST

Validate UPI ID and IFSC code

Validate UPI ID and IFSC code
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
ifsc_code
string
Nullable
IFSC Code
upi_vpa
string
Nullable
VPA Address
aggregator
string
Nullable
Aggregator Name
Response
200
400
Success. Returns the IFSC/VPA validation. Check the example shown below or refer `ValidateValidateAddressDetails` for more details.
ValidateValidateAddressDetails
upi
object (VPADetails)
UPI validation details.
VPADetails
is_valid
boolean
Is VPA valid or not
upi_vpa
string
VPA address
status
string
VPA validation message
customer_name
string
VPA Customer Name
success
boolean
Successful or not.
ifsc
object
IFSC details response data
vpa
object (VPADetails)
UPI validation details.
VPADetails
is_valid
boolean
Is VPA valid or not
upi_vpa
string
VPA address
status
string
VPA validation message
customer_name
string
VPA Customer Name
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/validate/beneficiary-address
Loading...
Response
Loading...
POST

Set a default beneficiary for a refund

set a default beneficiary for getting a refund.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
order_id
string
Required
Merchant Order Id
beneficiary_id
string
Required
Beneficiary Hash Id of the beneficiary added
shipment_id
string
Shipment Id from respective merchant order ID
merchant_shipment_id
string
Shipment Id from respective merchant order ID
Response
200
400
Success. Check the example shown below or refer `SetDefaultBeneficiaryDetails` for more details.
SetDefaultBeneficiaryDetails
is_beneficiary_set
boolean
Boolean Flag whether Beneficiary set or not
success
boolean
Response is successful or not
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/beneficiary/default
Loading...
Response
Loading...
GET

get beneficiary details

get beneficiary details
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
shipment_id
string
Required
Shipment id
Response
200
400
Success. Returns the Beneficiary details for the shipment. Check the example shown below or refer `ShipmentBeneficiaryDetailsRes` for more details.
ShipmentBeneficiaryDetailsRes
success
boolean
Response is successful or not.
shipment_id
string
Shipment Id
transfer_mode
object (TransferMode)
TransferMode
mode
string
display_name
string
message
string
message of response
beneficiary_details
string
Encrypted beneficiary details
Examples
Parameters
shipment_id:
"16100144824381402124"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refunds/beneficiary-details/{shipment_id}
Loading...
Response
Loading...

POS Payment

Efficiently manage Point of Sale (POS) payment modes and sessions, enabling seamless processing of payment initiation requests for UPI and QR code transactions, retrieval of payment modes offered by aggregators, conducting payment polling, facilitating payment link cancellation or resend, and providing the capability to check the status of individual payments as well as retrieve statuses for multiple payments in bulk.

Operations
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm
# Payment confirmation
POST

Payment confirmation

Authentication and confirmation of a payment.It requires details such as the order ID and payment methods in the request body to authenticate and confirm the payment.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
order_id
string
Required
Unique order id
payment_methods
array of object (MultiTenderPaymentMethod)
Required
Array of MultiTenderPaymentMethod
name
string
Payment mode name
meta
object (MultiTenderPaymentMeta)
MultiTenderPaymentMeta
extra_meta
object
Nullable
Key value pair for extra data related to payment mode
order_id
string
Fynd Platform order ID
payment_id
string
A unique identifier associated with a specific payment transaction
current_status
string
Represents the current state or condition of an object, such as an order or payment.
payment_gateway
string
key
string
Specifies the name or identifier of the payment gateway. This will deprecated in future version. We recommend switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
payment_gateway_slug
string
A simplified, URL-friendly string that represents the name of the payment gateway and it will used for refund PG.
amount
number
| float
Required
Payment amount
mode
string
Required
Payment mode short code
Response
200
Success. Returns the status of payment.
PaymentConfirmationDetails
order_id
string
Unique order id
message
string
Message
success
boolean
Payment confirmation updated or not.
errors
string
return_url
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm
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/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
# Get payment session
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
# Update payment session.
GET

Get payment session

Allows users to fetch the payment session details associated with a given order ID or transaction ID
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
gid
string
Required
transaction id
line-item
boolean
A boolean flag to include detailed cart and line item information in the response. When set to true, the response will contain comprehensive details about the cart, including each line item's product or service descriptions, quantities, unit prices, applicable taxes, discounts, total cart value, and total quantity. This provides a clear breakdown of charges to the customer, helping to understand the total amount billed in a more granular way.
Response
200
Get Payment Session Response
GetPaymentSessionDetails
meta
object
meta
gid
string
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
applied_payment_offers
object (AppliedOfferSerializerData)
AppliedOfferSerializerData
total_applied_offer_amount
number
Total applied offer amount
offer_list
array of object (OfferSerializerData)
Array of OfferSerializerData
offer_amount
number
Offer amount.
offer_code
string
Offer code.
offer_description
string
Offer description.
offer_id
string
Offer id.
checksum
string
status
string
status of the payment.
currency
string
currency of the payment.
payment_details
object (PaymentSessionDetail)
PaymentSessionDetail
payment_id
string
unique transaction id generated by payment gateway
mode
string
test or live, test mode uses test credentials so that actual payment is not created.
amount
integer
| int32
amount paid.
success_url
string
success url sent by Fynd platform at the time of payment creation
shipping_address
object (AddressDetail)
shipping address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
city name
tags
array of object
optional address tag
pincode
string
type
string
amount_captured
integer
| int32
amount which is captured or credited to merchant account
amount_refunded
integer
| int32
amount refunded or credited back to customer accout
aggregator_customer_id
string
unique customer id generated by payment gateway, not required for standard checkout.
cancel_url
string
cancel url sent by Fynd platform at the time of payment creation
payment_methods
array of object (PaymentMode)
method of payment
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
created
string
timestamp in epoch
g_user_id
string
global user identifier - unique user id generated by Fynd platform
currency
string
currency of the payment.
merchant_locale
string
merchant's locale
locale
string
user's locale
aggregator_order_id
string
unique order id or payment request id generated by payment gateway
gid
string
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
kind
string
optional kind of purchase or payment - one time payment (sale) or subcription. defaults to sale.
billing_address
object (AddressDetail)
billing address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
city name
tags
array of object
optional address tag
pincode
string
type
string
captured
boolean
whether the payment is captured (credited to merchant account) by payment gateway.
meta
object
Extra meta data specific to extension
status
string
status of the payment
cart_details
object (CartDetailsSerializerData)
CartDetailsSerializerData
items
object
Items that are added in cart
articles
array of object
list of articles that are added in cart
cart_value
number
| double
total cart value i.e. amount to be paid
cart_charges
array of object (CartChargesSerializerData)
contains all the charges that are applicable on cart
Array of CartChargesSerializerData
charge_type
string
Type of charge
name
string
Name of the charge
code
string
Unique identifier code for charge
amount
object (ChargeAmountSerializerData)
ChargeAmountSerializerData
ordering_currency
object (AmountSerializerData)
AmountSerializerData
value
integer
| int32
Amount in integer
currency
string
Currency in which amount is getting passed
base_currency
object (AmountSerializerData)
AmountSerializerData
value
integer
| int32
Amount in integer
currency
string
Currency in which amount is getting passed
total_quantity
integer
| int32
total number of items in cart
total_amount
integer
| int32
amount paid.
refund_details
array of object (RefundDetailsSerializerData)
object of refund details
Array of RefundDetailsSerializerData
amount
integer
| int32
refunded amount
currency
string
The currency of the payment.
request_id
string
refund request id, unique id generated by Fynd platform
status
string
The status of the refund.
created
string
timestamp in epoch.
refund_utr
string
Unique refund utr generated by payment gateway.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
gid:
"TR65C47E27CBFD964727"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
Loading...
Response
Loading...
PUT

Update payment session.

Update the details of a payment session associated with a given order ID or transaction ID.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
gid
string
Required
global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
Request body
meta
object
Extra meta data specific to extensions
gid
string
Required
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
applied_payment_offers
object (AppliedOfferSerializerData)
AppliedOfferSerializerData
total_applied_offer_amount
number
Total applied offer amount
offer_list
array of object (OfferSerializerData)
Array of OfferSerializerData
offer_amount
number
Offer amount.
offer_code
string
Offer code.
offer_description
string
Offer description.
offer_id
string
Offer id.
order_details
object (OrderDetail)
Required
The details of the order.
OrderDetail
gid
string
Required
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
amount
integer
| int32
Required
amount paid.
status
string
Required
order status created by payment gateway aggregator.
currency
string
Required
currency of the payment.
aggregator_order_details
object (AggregatorOrderDetail)
Required
AggregatorOrderDetail
aggregator_order_id
string
amount
integer
currency
string
aggregator
string
status
string
aggregator
string
Required
name of the payment gateway aggregator.
status
string
Required
status of the payment.
currency
string
Required
currency of the payment.
payment_details
array of object (PaymentSessionDetail)
Required
The payment details with the schema `PaymentSessionDetail`.
Array of PaymentSessionDetail
payment_id
string
Required
unique transaction id generated by payment gateway
mode
string
Required
test or live, test mode uses test credentials so that actual payment is not created.
amount
integer
| int32
Required
amount paid.
success_url
string
Required
success url sent by Fynd platform at the time of payment creation
shipping_address
object (AddressDetail)
shipping address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
Required
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
pincode
string
type
string
amount_captured
integer
| int32
Required
amount which is captured or credited to merchant account
amount_refunded
integer
| int32
amount refunded or credited back to customer accout
aggregator_customer_id
string
unique customer id generated by payment gateway, not required for standard checkout.
cancel_url
string
Required
cancel url sent by Fynd platform at the time of payment creation
payment_methods
array of object (PaymentMode)
Required
method of payment
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
created
string
timestamp in epoch
g_user_id
string
Required
global user identifier - unique user id generated by Fynd platform
currency
string
Required
currency of the payment.
merchant_locale
string
merchant's locale
locale
string
user's locale
aggregator_order_id
string
Required
unique order id or payment request id generated by payment gateway
gid
string
Required
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
kind
string
optional kind of purchase or payment - one time payment (sale) or subcription. defaults to sale.
billing_address
object (AddressDetail)
billing address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
Required
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
pincode
string
type
string
captured
boolean
whether the payment is captured (credited to merchant account) by payment gateway.
meta
object
Extra meta data specific to extension
status
string
Required
status of the payment
total_amount
integer
| int32
Required
amount paid.
checksum
string
Checksum to verify the payload
source
string
Source of payment update session
Response
200
400
Success. Returns the status of Update or not. for more details.
PaymentSessionPutDetails
gid
string
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
platform_transaction_details
array of object
platform transaction details.
status
string
status of the payment.
currency
string
currency of the payment.
total_amount
integer
| int32
amount paid.
error
string
success
boolean
message
string
transaction_details
array of object (TransactionDetail)
list of all payment mode and transaction id
Array of TransactionDetail
transaction_id
string
Unique identifier for the transaction
payment_mode
string
Mode of payment used in the transaction
amount
number
| float
Amount involved in the transaction
payment_id
string
unique number generated by extension
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
gid:
"TR65C47E27CBFD964727"
body:
body
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
Loading...
Response
Loading...

Refund

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/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
# Get bank account details
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
# Create refund account
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/order
# Get user order beneficiaries
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/user
# Get user beneficiaries.
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}
# Update refund session
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create
# Save bank details for cancelled/returned order
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create
# Delete saved beneficiary details of customers
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/refundoptions
# Save refund source against shipment and order
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/selected_refund_options
# get the selected refund options for shipment id
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation
# pennydrop validation
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation
# update penny drop validation for application ID
GET

Get bank account details

Retrieve bank account information
Requires application/payments/read access scope.
Parameters
order_id
string
Required
request_hash
string
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
400
Success
GetRefundAccountDetails
is_verified_flag
boolean
message
string
Response message
data
array of object (BankDetailsForOTP)
Refund account data.
Array of BankDetailsForOTP
ifsc_code
string
IFSC code of account
account_no
string
Account number
branch_name
string
branch name of account
bank_name
string
bank name of account
account_holder
string
accountg holder name of account
address
string
comment
string
email
string
mobile
string
beneficiary_id
string
success
boolean
Success or failure flag.
Examples
Parameters
order_id:
"FY65C2797B2F00FCF07E"
request_hash:
"asdaddsd"
company_id:
1
application_id:
"000000000000000000000001"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
Loading...
Response
Loading...
POST

Create refund account

The addition of a bank account specifically for refunds, employing OTP verification for security - Payment
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
transfer_mode
string
shipment_id
string
delights
boolean
order_id
string
Required
order_id for which account will be added
details
object (BankDetailsForOTP)
Required
BankDetailsForOTP
ifsc_code
string
Required
IFSC code of account
account_no
string
Required
Account number
branch_name
string
Required
branch name of account
bank_name
string
Required
bank name of account
account_holder
string
Required
accountg holder name of account
address
string
comment
string
email
string
mobile
string
beneficiary_id
string
Response
200
400
Success
RefundAccountDetails
is_verified_flag
boolean
account is verified or not
message
string
Response message
data
object
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
Loading...
Response
Loading...
GET

Get user order beneficiaries

Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing
Requires application/payments/read access scope.
Parameters
order_id
string
Required
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
List Order Beneficiary
OrderBeneficiaryFetchResults
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
subtitle
string
SHort Title Of Account
id
integer
| int32
title
string
Title Of Account
account_holder
string
Account Holder Name
ifsc_code
string
Ifsc Code Of Account
comment
string
Remarks
created_on
string
Creation Date of Beneficiary
display_name
string
Display Name Of Account
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
transfer_mode
string
Transfer Mode Of Account
email
string
Email of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
branch_name
string
Branch Name Of Account
address
string
Address of User
modified_on
string
Modification Date of Beneficiary
beneficiary_id
string
Benenficiary Id
aggregator_id
integer
Nullable
is_verified
boolean
Nullable
status
string
Nullable
txn_id
string
Nullable
meta
object
Nullable
bank_name
string
account_no
string
mobile
string
Nullable
default_beneficiary
boolean
Nullable
show_beneficiary_details
boolean
Show beneficiary details or not.
bank
array of object (OrderBeneficiaryDetails)
Array of OrderBeneficiaryDetails
subtitle
string
SHort Title Of Account
id
integer
| int32
title
string
Title Of Account
account_holder
string
Account Holder Name
ifsc_code
string
Ifsc Code Of Account
comment
string
Remarks
created_on
string
Creation Date of Beneficiary
display_name
string
Display Name Of Account
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
transfer_mode
string
Transfer Mode Of Account
email
string
Email of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
branch_name
string
Branch Name Of Account
address
string
Address of User
modified_on
string
Modification Date of Beneficiary
beneficiary_id
string
Benenficiary Id
aggregator_id
integer
Nullable
is_verified
boolean
Nullable
status
string
Nullable
txn_id
string
Nullable
meta
object
Nullable
bank_name
string
account_no
string
mobile
string
Nullable
default_beneficiary
boolean
Nullable
Examples
Parameters
order_id:
"FY65C2797B2F00FCF07E"
company_id:
1
application_id:
"000000000000000000000001"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/order
Loading...
Response
Loading...
GET

Get user beneficiaries.

Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID
Requires application/payments/read access scope.
Parameters
order_id
string
Required
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
400
List User Beneficiary
OrderBeneficiaryFetchResults
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
subtitle
string
SHort Title Of Account
id
integer
| int32
title
string
Title Of Account
account_holder
string
Account Holder Name
ifsc_code
string
Ifsc Code Of Account
comment
string
Remarks
created_on
string
Creation Date of Beneficiary
display_name
string
Display Name Of Account
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
transfer_mode
string
Transfer Mode Of Account
email
string
Email of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
branch_name
string
Branch Name Of Account
address
string
Address of User
modified_on
string
Modification Date of Beneficiary
beneficiary_id
string
Benenficiary Id
aggregator_id
integer
Nullable
is_verified
boolean
Nullable
status
string
Nullable
txn_id
string
Nullable
meta
object
Nullable
bank_name
string
account_no
string
mobile
string
Nullable
default_beneficiary
boolean
Nullable
show_beneficiary_details
boolean
Show beneficiary details or not.
bank
array of object (OrderBeneficiaryDetails)
Array of OrderBeneficiaryDetails
subtitle
string
SHort Title Of Account
id
integer
| int32
title
string
Title Of Account
account_holder
string
Account Holder Name
ifsc_code
string
Ifsc Code Of Account
comment
string
Remarks
created_on
string
Creation Date of Beneficiary
display_name
string
Display Name Of Account
delights_user_name
string
Nullable
User Id Who filled the Beneficiary
transfer_mode
string
Transfer Mode Of Account
email
string
Email of User
is_active
boolean
Boolean Flag whether Beneficiary set or not
branch_name
string
Branch Name Of Account
address
string
Address of User
modified_on
string
Modification Date of Beneficiary
beneficiary_id
string
Benenficiary Id
aggregator_id
integer
Nullable
is_verified
boolean
Nullable
status
string
Nullable
txn_id
string
Nullable
meta
object
Nullable
bank_name
string
account_no
string
mobile
string
Nullable
default_beneficiary
boolean
Nullable
Examples
Parameters
order_id:
"FY65C2797B2F00FCF07E"
company_id:
1
application_id:
"000000000000000000000001"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/user
Loading...
Response
Loading...
PUT

Update refund session

Allows users to update the details of a refund session associated with a specific global identifier (GID) and request ID.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
gid
string
Required
global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
request_id
string
Required
A unique id that was used to initiate a refund session. This is generated by Fynd platform and is usually shipment_id.
Request body
meta
object
meta
gid
string
Required
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
status
string
Required
The status of the refund.
currency
string
Required
The currency of the payment.
payment_details
object (PaymentSessionDetail)
Required
details of the payment
PaymentSessionDetail
payment_id
string
Required
unique transaction id generated by payment gateway
mode
string
Required
test or live, test mode uses test credentials so that actual payment is not created.
amount
integer
| int32
Required
amount paid.
success_url
string
Required
success url sent by Fynd platform at the time of payment creation
shipping_address
object (AddressDetail)
shipping address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
Required
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
pincode
string
type
string
amount_captured
integer
| int32
Required
amount which is captured or credited to merchant account
amount_refunded
integer
| int32
amount refunded or credited back to customer accout
aggregator_customer_id
string
unique customer id generated by payment gateway, not required for standard checkout.
cancel_url
string
Required
cancel url sent by Fynd platform at the time of payment creation
payment_methods
array of object (PaymentMode)
Required
method of payment
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
created
string
timestamp in epoch
g_user_id
string
Required
global user identifier - unique user id generated by Fynd platform
currency
string
Required
currency of the payment.
merchant_locale
string
merchant's locale
locale
string
user's locale
aggregator_order_id
string
Required
unique order id or payment request id generated by payment gateway
gid
string
Required
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
kind
string
optional kind of purchase or payment - one time payment (sale) or subcription. defaults to sale.
billing_address
object (AddressDetail)
billing address
AddressDetail
line1
string
line2
string
google_map_point
object (GoogleMapPoint)
GoogleMapPoint
address
string
sub_locality
string
landmark
string
landmark
phone
string
phone number
country_iso_code
string
country's code name e.g. `IN`, `GB`
area_code
string
customer pin/zip code
country
string
Required
country name
expire_at
string
| date-time
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
area details
g_address_id
string
unique address id generated by Fynd platform
area_code_slug
string
area slug code, use pin or zip code if not available
country_phone_code
string
country's phone code
name
string
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
pincode
string
type
string
captured
boolean
whether the payment is captured (credited to merchant account) by payment gateway.
meta
object
Extra meta data specific to extension
status
string
Required
status of the payment
checksum
string
Required
total_amount
integer
| int32
Required
The total amount refunded.
refund_details
array of object (RefundSessionDetail)
details of the refund
Array of RefundSessionDetail
refund_utr
string
Unique refund utr generated by payment gateway.
request_id
string
Required
refund request id, unique id generated by Fynd platform
payment_id
string
Required
Unique payment id generated by payment gateway.
amount
integer
| int32
Required
amount refunded.
reason
string
reason for refund, optional
status
string
Required
status of the refund.
created
string
Required
timestamp in epoch.
source_transfer_reversal
string
description in case of reversal of payment.
currency
string
Required
currency of the payment.
transfer_reversal
string
description in case of reversal of payment.
balance_transaction
string
balance transaction.
error
object (ErrorDescription)
ErrorDescription
msg
string
Nullable
Message
payment_transaction_id
string
Nullable
Payment transaction id
invalid_id
boolean
Nullable
Payment link id is valid or not
merchant_order_id
string
Nullable
Order id
merchant_name
string
Nullable
Name of merchant that created payment link
amount
number
| float
Nullable
Amount paid
expired
boolean
Nullable
Payment link expired or not
cancelled
boolean
Nullable
Payment link is cancelled or not
description
string
Nullable
message
string
The status of the refund.
Response
200
Returns the response whether it is success or not. for more details.
RefundSessionDetails
success
boolean
message
string
gid
string
Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.
status
string
The status of the refund.
currency
string
The currency of the payment.
platform_refund_details
array of object
details of the refund
total_refund_amount
integer
| int32
The total amount refunded.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
gid:
"FY65C2797B2F00FCF07E"
request_id:
"1"
body:
body
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}
Loading...
Response
Loading...
POST

Save bank details for cancelled/returned order

save bank details for returned/cancelled order to refund amount in his account.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
transfer_mode
string
shipment_id
string
delights
boolean
order_id
string
Required
order_id for which account will be added
details
object (BankDetailsForOTP)
Required
BankDetailsForOTP
ifsc_code
string
Required
IFSC code of account
account_no
string
Required
Account number
branch_name
string
Required
branch name of account
bank_name
string
Required
bank name of account
account_holder
string
Required
accountg holder name of account
address
string
comment
string
email
string
mobile
string
beneficiary_id
string
Response
200
400
Success
RefundAccountDetails
is_verified_flag
boolean
account is verified or not
message
string
Response message
data
object
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create
Loading...
Response
Loading...
PATCH

Delete saved beneficiary details of customers

Delete the saved beneficiary details provided beneficiary Id.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
beneficiary_id
string
Saved Beneficiary ID
Response
200
Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
DeleteRefundAccountDetails
success
boolean
Success/Failure of the deleted beneficiary
message
string
Nullable
Message
Examples
Parameters
body:
body
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create
Loading...
Response
Loading...
POST

Save refund source against shipment and order

Save refund source against shipment and order
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
order_id
string
Required
Merchant Order Id
transfer_mode
string
Required
Transfer Mode of the Beneficiary to be added
beneficiary_id
string
Nullable
Beneficiary Hash Id of the beneficiary added
shipment_ids
array of string
Nullable
Detailed list of shipment IDs for single and multi-bag return cases
meta
object (ShipmentRefundDetailsMeta)
ShipmentRefundDetailsMeta
shipment_id
string
Shipment Id of the respective Merchant Order Id
name
string
Name of the Transfer Mode.
utr
string
Unique Transaction Reference of the refund.
notes
string
Nullable
Any optional notes regarding the transaction.
billing_employee_code
string
Nullable
Billing Employee Code
Response
200
400
Success. Returns the status of saved refund source for shipment and order. Check the example shown below or refer `ShipmentRefundRes` for more details.
ShipmentRefundRes
data
object (ShipmentRefundDetail)
Selected Shipment refund option details.
ShipmentRefundDetail
order_id
string
Order ID
transfer_mode
string
TransferMode
beneficiary_id
string
Beneficiary ID
shipment_ids
array of string
Nullable
Detailed list of shipment IDs for single and multi-bag return cases
success
boolean
Successful or not.
message
string
Nullable
message
refund_options
string
refund_options_priority
object (RefundOptionsPriority)
RefundOptionsPriority
payment_modes
array of string
items
array of object (RefundItem)
Array of RefundItem
id
integer
name
string
display_name
string
is_active
boolean
payment_gateways
array of string
List of all offline payment gateways.
offline_refund_collect_type
array of string
List of all offline Refund Collect Types.
offline_refund_options_priority
object (RefundOptionsPriority)
RefundOptionsPriority
payment_modes
array of string
items
array of object (RefundItem)
Array of RefundItem
id
integer
name
string
display_name
string
is_active
boolean
payment_gateways
array of string
List of all offline payment gateways.
offline_refund_collect_type
array of string
List of all offline Refund Collect Types.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/refundoptions
Loading...
Response
Loading...
GET

get the selected refund options for shipment id

get the selected refund options for shipment id
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
shipment_id
string
Required
shipment Id
order_id
string
Required
Order Id
Response
200
Success. Returns the selected refund option for shipment. Check the example shown below or refer `SelectedRefundOptionDetailsSchema` for more details.
SelectedRefundOptionDetails
transfer_mode
object (TransferMode)
TransferMode
mode
string
display_name
string
shipment_id
string
Nullable
Shipment ID
message
string
Nullable
message
success
boolean
Successful or not.
beneficiary_details
object
Beneficiary Short description
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
shipment_id:
"16100144824381402124"
order_id:
"FY65C2797B2F00FCF07E"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/selected_refund_options
Loading...
Response
Loading...
GET

pennydrop validation

get pennydrop validation for bank account
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
Success. Returns the status of pennydrop validation. Check the example shown below or refer `PennyDropValidationDetails` for more details.
PennyDropValidationDetails
success
boolean
Successful or not.
message
string
Nullable
message
allow_pennydrop_validation
boolean
PennyDrop validation flag.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation
Loading...
Response
Loading...
POST

update penny drop validation for application ID

update penny drop validation for application ID
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
allow_pennydrop_validation
boolean
Required
Allow Penny Drop Validation flag
Response
200
400
Success. Returns the status for pennydrop validation flag. Check the example shown below or refer `PennyDropValidationDetails` for more details.
PennyDropValidationDetails
success
boolean
Successful or not.
message
string
Nullable
message
allow_pennydrop_validation
boolean
PennyDrop validation flag.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation
Loading...
Response
Loading...

Seller payment mode

Seller payment mode refers to the specific payment methods accepted by a seller for processing transactions. These payment modes can include various options such as credit card payments, debit card payments, digital wallets, bank transfers, cash on delivery (COD), and other forms of electronic payments. Seller typically configure their payment systems to accept one or more payment modes based on their business needs and the preferences of their customers.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing
# Get details for the active inactive payment modes for merchant
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing
# Update sequencing of payment modes for the merchant
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/all-devices
# Get all business units and it's devices.
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing/copy-config
# Copy payment mode config of onc device to another.
GET

Get details for the active inactive payment modes for merchant

get details for the given payment modes and its sequencingfor merchant
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
business_unit
string
Required
device
string
Required
Response
200
Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
PaymentModeDetails
success
boolean
message
string
items
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
business_unit:
"storefront"
device:
"android"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing
Loading...
Response
Loading...
PATCH

Update sequencing of payment modes for the merchant

Update sequencing of payment modes for the merchant
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
business_unit
string
Business unit identifier.
device
string
Device identifier.
is_active
boolean
Indicates if the payment option is active.
items
array of object (PaymentModeItem)
List of all aggregator and payment mode details.
Array of PaymentModeItem
id
integer
Identifier for the payment mode.
name
string
Name of the payment mode.
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
is_active
boolean
Indicates if the payment mode is active.
priority
integer
sub_payment_mode
array of object (SubPaymentMode)
List of sub-payment modes.
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
Required
large
small
string
| url
Required
smalll
Response
200
Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
AggregatorConfigDetails
success
boolean
message
string
items
array of object (PaymentOptionItem)
Array of PaymentOptionItem
id
integer
name
string
priority
integer
display_name
string
slug
string
integration_type
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
is_active
boolean
config
array of string
payment_modes
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
payment_mode
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
checkout_type
string
country
array of string
currency
array of string
status
string
save_allowed
boolean
Indicates if saving is allowed.
extension_id
string
Nullable
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing
Loading...
Response
Loading...
GET

Get all business units and it's devices.

Get all business units and it's devices.
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
Success Returns all business units and it's devices.
GetDevice
message
string
Nullable
Message
success
boolean
Response is successful or not.
items
object (BusinessUnitDevice)
BusinessUnitDevice
business_unit
array of object (BusinessUnit)
Array of BusinessUnit
name
string
The name of the business unit.
slug
string
The slug of the business unit.
device
array of object (Device)
List of devices.
Array of Device
name
string
The name of the device.
slug
string
The slug of the device.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/all-devices
Loading...
Response
Loading...
PATCH

Copy payment mode config of onc device to another.

Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device.
Requires application/payments/write access scope.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
from_config
object (FromConfig)
Required
FromConfig
device
string
Required
Device name
business_unit
string
Required
Business unit name
to_config
object (ToConfig)
Required
ToConfig
device
array of string
Required
business_unit
string
Required
Business unit name
Response
200
400
Enable/Disable the aggregator and return updated response.
AggregatorConfigDetails
success
boolean
message
string
items
array of object (PaymentOptionItem)
Array of PaymentOptionItem
id
integer
name
string
priority
integer
display_name
string
slug
string
integration_type
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
is_active
boolean
config
array of string
payment_modes
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
payment_mode
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
checkout_type
string
country
array of string
currency
array of string
status
string
save_allowed
boolean
Indicates if saving is allowed.
extension_id
string
Nullable
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing/copy-config
Loading...
Response
Loading...

TransactionManagement

APIs for managing transaction data, including retrieval by user ID or order ID. Provides detailed transaction information such as status, amount, and related order details.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/transactions
# Retrieve transaction history by user or order
GET

Retrieve transaction history by user or order

Fetches a list of transactions associated with a specific user ID or order ID. Allows filtering and pagination to retrieve specific transaction records.
Requires application/payments/read access scope.
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
user_id
string
User ID of the user
page_size
integer
Size of the page, default and max value is 10
Default Value : 10
page_number
integer
Page number, default is 1
Default Value : 1
order_id
string
Order ID for which transaction data is needed
shipment_id
string
Shipment ID for which transaction data is needed
transaction_id
string
Transaction ID for which transaction data is needed
Response
200
400
Success. Returns the list of transaction and order data using order_id or the user_id.
TransactionsResponseSchema
success
boolean
Indicates whether the request was successful.
orders
object
Order Data for the order_id.
page
object (PageData)
PageData
page_size
integer
Page size of the response.
current_page
integer
Current page number of the response.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
user_id:
"5c5c0b0a3fe3c6d1ae4ea1fc"
page_size:
3
page_number:
1
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/transactions
Loading...
Response
Loading...