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
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregators/{aggregator_id}/token
# Save token details for a payment aggregator
POST

Save token details for a payment aggregator

Save token and verification status for a specific payment aggregator, such as Apple Pay or others.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
aggregator_idpath
string
Required
Payment aggregator identifier. Supported values are: - **1**: Razorpay - **2**: Juspay - **3**: Checkout Extension - **4**: PayU India Extension
Enum
Request body
payment_mode_id
integer
Required
Payment mode identifier Supported values are: - **4**: Wallet - **3**: Net Banking - **2**: Card - **1**: Pay Later
Enum
sub_payment_mode_code
string
Required
Sub-payment method code
token
string
Required
Token value to be saved for the aggregator
status
string
Required
Status of the token verification
Enum
is_active
boolean
Required
Enable or Disable Flag
domain
string
Required
Name of domain
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregators/{aggregator_id}/token
Loading...
Response
200
400
Token successfully saved
Hide
success
boolean
Indicates if the operation was successful
message
string
Optional message providing additional information about the operation
Examples
Parameters
Parameters are not required.
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.
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
Request body
order_id
string
Required
Unique order id
payment_methods
array of object (MultiTenderPaymentMethod)
Required
Show
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm
Loading...
Response
200
400
Success. Returns the status of payment.
Hide
order_id
string
Unique order id
message
string
Message
success
boolean
Payment confirmation updated or not.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
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/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/validate/customer-credits
# Verify payment customer and show credit summary
POST

Verify payment customer and show credit summary

Verify if the user is eligible for payment and also show credit summary if activated.
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
Request body
aggregator
string
Required
Aggregator name of the payment gateway.
transaction_amount
number
| float
Required
Payable amount
cart_id
string
Unique identifier for the shopping cart.
user_id
string
The unique identifier of the user.
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/validate/customer-credits
Loading...
Response
200
400
Success. Check the example shown below or refer `ValidateCustomerCreditSchema` for more details.
Hide
success
boolean
Successful or failure of API
is_eligible
boolean
The customer is eligible to make a transaction or not
is_applied
boolean
Credit is applied to the user's account or not
message
string
Detailed message about the user credt eligibility.
cart_id
string
Unique identifier for the shopping cart.
account
object (CreditAccountSummary)
Show
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
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
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/order/meta
# Update order metadata
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/orders/{order_id}/transactions
# List all transactions for an order
GET

Get payment session

Allows users to fetch the payment session details associated with a given order ID or transaction ID
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
gidpath
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.
line-itemquery
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.
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
Loading...
Response
200
400
Success. Returns the details of payment session.
Hide
payment_details
Undefined Type
object of payment details
currency
string
Nullable
The currency of the payment.
status
string
The status of the payment session.
total_amount
integer
| int32
total amount to be paid
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.
cart_details
object (CartDetails)
Show
refund_details
array of object (RefundDetails)
object of refund details
Show
Examples
Parameters
company_id:
1
application_id:
"64bf81dcc07acacc135733ea"
gid:
"TR9C4AF3A615DE251A23"
line-item:
true
Response
Loading...
PUT

Update payment session

Update the details of a payment session associated with a given order ID or transaction ID.
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
gidpath
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.
order_details
object (OrderDetail)
Required
The details of the order.
Show
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`.
Show
total_amount
integer
| int32
Required
amount paid.
checksum
string
Required
Checksum to verify the payload
source
string
Source of payment update session
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
Loading...
Response
200
400
Success. Returns the status of Update or not. for more details.
Hide
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.
Examples
Parameters
company_id:
1
application_id:
"64bf81dcc07acacc135733ea"
gid:
"TR65C47E27CBFD964727"
body:
body
Response
Loading...
PUT

Update order metadata

Update metadata associated with a payment order. Use this to set or update PAN (Permanent Account Number) for an order.
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
order_idquery
string
Required
The unique identifier of the order (merchant_order_id).
Request body
pan_no
string
Required
Valid Indian PAN (Permanent Account Number). Format: 5 letters, 4 digits, 1 letter (e.g. AAAAA9999A). Case-insensitive; stored in uppercase.
Minimum Length : 10
Maximum Length : 10
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/order/meta
Loading...
Response
200
400
Returns a message indicating the success of order meta updation as shown below.
Hide
Order meta update success response schema.
message
string
Success message indicating order meta was updated.
Examples
Parameters
company_id:
1
application_id:
"value"
order_id:
"value"
body:
body
Response
Loading...
GET

List all transactions for an order

Returns all payment transactions associated with the given order ID, ordered by creation timestamp ascending. Each entry includes the merchant transaction ID, payment mode name, logo URL (small, falling back to large), transaction amount, latest status, and creation timestamp.
Parameters
company_idpath
integer
| int64
Required
Unique numeric identifier of the company (seller).
application_idpath
string
Required
Unique identifier of the sales channel (application).
order_idpath
string
Required
Merchant order ID (e.g. FY692D2AC45171FB895B).
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/orders/{order_id}/transactions
Loading...
Response
200
400
List of transactions for the order.
Hide
success
boolean
Whether the request was successful.
items
array of object (OrderTransactionItem)
List of transactions ordered by created_on ascending.
Show
Examples
Parameters
company_id:
1
application_id:
"value"
order_id:
"value"
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
GET

Get bank account details

Retrieve bank account information
Parameters
order_idquery
string
Required
request_hashquery
string
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
Loading...
Response
200
400
Success
Hide
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
order_id:
"FY65C2797B2F00FCF07E"
request_hash:
"asdaddsd"
company_id:
1
application_id:
"000000000000000000000001"
Response
Loading...
POST

Create refund account

The addition of a bank account specifically for refunds, employing OTP verification for security
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
Request body
order_id
string
Required
order_id for which account will be added
shipment_id
string
shipment_id for which account will be added
details
object (BankDetailsForOTP)
Required
Show
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
Loading...
Response
200
400
Success
Hide
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
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
Parameters
order_idquery
string
Required
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/order
Loading...
Response
200
400
List Order Beneficiary
Hide
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Show
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
order_id:
"FY65C2797B2F00FCF07E"
company_id:
1
application_id:
"000000000000000000000001"
Response
Loading...
GET

Get user beneficiaries

Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID
Parameters
order_idquery
string
Required
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/user
Loading...
Response
200
400
List User Beneficiary
Hide
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Show
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
order_id:
"FY65C2797B2F00FCF07E"
company_id:
1
application_id:
"000000000000000000000001"
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.
Parameters
company_idpath
integer
Required
Company Id
application_idpath
string
Required
Application id
gidpath
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_idpath
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
Show
total_amount
integer
| int32
Required
The total amount refunded.
refund_details
array of object (RefundSessionDetail)
Required
details of the refund
Show
error
object (ErrorDescription)
Show
message
string
The status of the refund.
checksum
string
Required
Checksum to verify payload
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}
Loading...
Response
200
400
Returns the response whether it is success or not. for more details.
Hide
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:
"64bf81dcc07acacc135733ea"
gid:
"FY615DE25839C4AF3A1A"
request_id:
"16100144824381402124"
body:
body
Response
Loading...