Payment
Collect payment through many payment gateway i.e Stripe, Razorpay, Juspay etc.into Fynd or Self account
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
# 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_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
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.
PaymentConfirmationResponse
order_id
string
Unique order id
message
string
Message
success
boolean
Payment confirmation updated or not.
Examples
Parameters
companyId:
1
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Payment confirmation
confirmPayment
Payment
Payment system refers to the mechanism by which customers can securely and conveniently pay for the products or services they wish to purchase. It involves integrating various payment methods such as credit/debit cards, digital wallets, bank transfers, and sometimes cash on delivery (COD) to accommodate different customer preferences.It typically involves - Payment Gateway Integration: Connecting the website to payment gateways like PayPal, Stripe, or other third-party processors to facilitate online transactions securely. Secure Transactions: Implementing encryption protocols and secure socket layers (SSL) to protect customers' payment information from unauthorized access or cyber threats. Multiple Payment Options: Offering diverse payment methods to cater to a wide range of customers, including credit/debit cards, digital wallets (e.g., Apple Pay, Google Pay), and alternative methods like cryptocurrencies or buy-now-pay-later services. Checkout Process: Streamlining the checkout process to minimize friction and make it easy for customers to complete their purchases swiftly. Payment Confirmation: Providing instant confirmation of successful payments and sending receipts or order confirmations to customers via email or SMS.
Operations
GET
# Get payment session
PUT
# Update payment session
GET
Get payment session
Allows users to fetch the payment session details associated with a given order ID or transaction ID
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.
line-item
boolean
line-item to add extra data into response (e.g. cart details)
Response
200
400
500
Success. Returns the details of payment session. Check the example shown below or refer `PaymentSessionSerializer` for more details.
PaymentSessionSerializer
payment_details
object
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
Nullable
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 (CartDetailsSerializer)
CartDetailsSerializer
refund_details
array of object (RefundDetailsSerializer)
object of refund details
Array of RefundDetailsSerializer
Examples
Parameters
companyId:
1
applicationId:
"value"
gid:
"value"
lineItem:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get payment session
getPaymentSession
PUT
Update payment session
Update the details of a payment session associated with a given order ID or transaction ID.
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
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.
order_details
object (OrderDetail)
Required
The details of the order.
OrderDetail
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
total_amount
integer
| int32
Required
amount paid.
checksum
string
Required
Checksum to verify the payload
Response
200
400
500
Success. Returns the status of Update or not. Check the example shown below or refer `PaymentSessionResponseSerializer` for more details.
PaymentSessionResponseSerializer
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
companyId:
1
applicationId:
"64bf81dcc07acacc135733ea"
gid:
"FY615DE25839C4AF3A1A"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update payment session
updatePaymentSession
Payment link
Payment link is a URL or hyperlink that directs users to a webpage where they can make a payment for their products. It's often used in situations where the seller needs to collect payment from a customer who is not physically present or when the payment needs to be processed remotely. Payment links can be sent via email, SMS, messaging apps, or embedded on a website, allowing customers to conveniently complete their transactions online.Enable the creation and management of payment links
Operations
GET
# Get payment link
POST
# Create payment link
GET
# Poll status of payment link
POST
# Resend payment link
POST
# Cancel payment link
GET
Get payment link
Retrieve a payment link for making payments.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
payment_link_id
string
Unique payment link id
Response
200
400
500
Success. Check the example shown below
GetPaymentLinkResponse
message
string
Message
status_code
integer
| int32
HTTP status code
amount
number
| float
Nullable
Total value of order
merchant_name
string
Nullable
Merchant name
payment_link_url
string
Nullable
Url of payment link
payment_link_current_status
string
Nullable
Status of payment link
external_order_id
string
Nullable
Merchant order id
polling_timeout
integer
| int32
Nullable
Polling request timeout
success
boolean
Successful or failure
Examples
Parameters
companyId:
1
applicationId:
"value"
paymentLinkId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get payment link
getPaymentLink
POST
Create payment link
Generate a payment link for accepting payments.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
email
string
Required
Email to which the payment link is to be sent
amount
number
| float
Required
Total value of order
mobile_number
string
Required
Mobile number to which the payment link is to be sent
country_phone_code
string
Phone country code for complete mobile number
description
string
Nullable
Merchant order id
meta
object (CreatePaymentLinkMeta)
Required
CreatePaymentLinkMeta
external_order_id
string
Required
Merchant order id
Response
200
400
500
Success. Check the example shown below
CreatePaymentLinkResponse
message
string
Message
status_code
integer
| int32
HTTP status code
payment_link_url
string
Nullable
Url of payment link
polling_timeout
integer
| int32
Nullable
Polling request timeout
success
boolean
Successful or failure
payment_link_id
string
Nullable
Unique id of payment link
Examples
Parameters
companyId:
1
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create payment link
createPaymentLink
GET
Poll status of payment link
Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
payment_link_id
string
Unique payment link id
Response
200
400
500
Success. Check the example shown below
PollingPaymentLinkResponse
message
string
Nullable
Message
http_status
integer
| int32
Nullable
HTTP status code
status_code
integer
| int32
Nullable
HTTP status code
redirect_url
string
Nullable
Url to redirect to
amount
number
| float
Nullable
Amount
order_id
string
Nullable
Fynd order id
success
boolean
Nullable
Successful or failure
payment_link_id
string
Nullable
Payment link id
status
string
Nullable
Status of payment link
aggregator_name
string
Nullable
Aggregator name
Examples
Parameters
companyId:
1
applicationId:
"value"
paymentLinkId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Poll status of payment link
pollingPaymentLink
POST
Resend payment link
Resends an existing payment link to the user to complete the payment.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
payment_link_id
string
Required
Unique id of payment link
Response
200
400
500
Success. Check the example shown below
ResendPaymentLinkResponse
status_code
integer
| int32
HTTP status code
message
string
Message
polling_timeout
integer
| int32
Nullable
Polling request timeout
success
boolean
Successful or failure
Examples
Parameters
companyId:
1
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Resend payment link
resendPaymentLink
POST
Cancel payment link
Deactivate and cancel a payment link.
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
payment_link_id
string
Required
Unique id of payment link
Response
200
400
500
Success. Check the example shown below
CancelPaymentLinkResponse
status_code
integer
| int32
HTTP status code
message
string
Message
success
boolean
Successful or failure
Examples
Parameters
companyId:
1
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Cancel payment link
cancelPaymentLink
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
# Get bank account details
POST
# Create refund account
GET
# Get user order beneficiaries
GET
# Get user beneficiaries
PUT
# Update refund session
GET
Get bank account details
Retrieve bank account information
Parameters
order_id
string
Required
request_hash
string
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
400
500
Success
RefundAccountResponse
is_verified_flag
boolean
message
string
Response message
data
object
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
orderId:
"value"
requestHash:
"value"
companyId:
1
applicationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get bank account details
getBankAccountDetailsOpenAPI
POST
Create refund account
The addition of a bank account specifically for refunds, employing OTP verification for security
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
order_id
string
Required
details
object (BankDetailsForOTP)
Required
BankDetailsForOTP
Response
200
400
500
Success
RefundAccountResponse
is_verified_flag
boolean
message
string
Response message
data
object
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
companyId:
1
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create refund account
addRefundBankAccountUsingOTP
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_id
string
Required
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
400
500
List Order Beneficiary
OrderBeneficiaryResponse
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
orderId:
"value"
companyId:
1
applicationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get user order beneficiaries
getUserOrderBeneficiaries
GET
Get user beneficiaries
Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID
Parameters
order_id
string
Required
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Response
200
400
500
List User Beneficiary
OrderBeneficiaryResponse
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
orderId:
"value"
companyId:
1
applicationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get user beneficiaries
getUserBeneficiaries
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_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
total_amount
integer
| int32
Required
The total amount refunded.
refund_details
array of object (RefundSessionDetail)
Required
details of the refund
Array of RefundSessionDetail
error
object (ErrorDescription)
ErrorDescription
message
string
The status of the refund.
checksum
string
Required
Checksum to verify payload
Response
200
400
500
Returns the response weather it is success or not. Check the example shown below or refer `RefundSessionResponseSerializer` for more details.
RefundSessionResponseSerializer
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
companyId:
1
applicationId:
"64bf81dcc07acacc135733ea"
gid:
"FY615DE25839C4AF3A1A"
requestId:
"16100144824381402124"
Was this section helpful?
PUT
Loading...
Response
Loading...