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
/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_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
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
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
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
company_id:
1
application_id:
"value"
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
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
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
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
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
total_quantity
integer
| int32
total number of items in cart
custom_cart_meta
object
this field is used to add and retrieve custom data fields to cart items.
refund_details
array of object (RefundDetailsSerializer)
object of refund details
Array of RefundDetailsSerializer
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:
"value"
gid:
"value"
line-item:
false
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.
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
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
Required
aggregator order details generated by the payment gateway.
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
google_map_point
object
google map point of location
landmark
string
landmark
phone
string
Required
phone number
country_iso_code
string
Required
country's code name e.g. `IN`, `GB`
area_code
string
Required
customer pin/zip code
country
string
Required
country name
expire_at
string
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
Required
area details
g_address_id
string
Required
unique address id generated by Fynd platform
area_code_slug
string
Required
area slug code, use pin or zip code if not available
country_phone_code
string
Required
country's phone code
name
string
Required
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
Required
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
amount_captured
integer
| int32
Required
amount which is captured or credited to merchant account
amount_refunded
integer
| int32
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
Required
method of payment
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
google_map_point
object
google map point of location
landmark
string
landmark
phone
string
Required
phone number
country_iso_code
string
Required
country's code name e.g. `IN`, `GB`
area_code
string
Required
customer pin/zip code
country
string
Required
country name
expire_at
string
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
Required
area details
g_address_id
string
Required
unique address id generated by Fynd platform
area_code_slug
string
Required
area slug code, use pin or zip code if not available
country_phone_code
string
Required
country's phone code
name
string
Required
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
Required
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
captured
boolean
whether the payment is captured (credited to merchant account) by payment gateway.
meta
object
Metadata
status
string
Required
stautus of the payment
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
company_id:
1
application_id:
"64bf81dcc07acacc135733ea"
gid:
"FY615DE25839C4AF3A1A"
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
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
order_id:
"value"
request_hash:
"value"
company_id:
1
application_id:
"value"
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
Parameters
company_id
integer
Required
Company Id
application_id
string
Required
Application id
Request body
order_id
string
Required
details
object (BankDetailsForOTP)
Required
BankDetailsForOTP
ifsc_code
string
Required
account_no
string
Required
branch_name
string
Required
bank_name
string
Required
account_holder
string
Required
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
company_id:
1
application_id:
"value"
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
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
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
account_no
string
Account Number
bank_name
string
Bank Name Of Account
mobile
string
MObile no of User
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
order_id:
"value"
company_id:
1
application_id:
"value"
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
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
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
account_no
string
Account Number
bank_name
string
Bank Name Of Account
mobile
string
MObile no of User
show_beneficiary_details
boolean
Show beneficiary details or not.
Examples
Parameters
order_id:
"value"
company_id:
1
application_id:
"value"
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.
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
google_map_point
object
google map point of location
landmark
string
landmark
phone
string
Required
phone number
country_iso_code
string
Required
country's code name e.g. `IN`, `GB`
area_code
string
Required
customer pin/zip code
country
string
Required
country name
expire_at
string
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
Required
area details
g_address_id
string
Required
unique address id generated by Fynd platform
area_code_slug
string
Required
area slug code, use pin or zip code if not available
country_phone_code
string
Required
country's phone code
name
string
Required
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
Required
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
amount_captured
integer
| int32
Required
amount which is captured or credited to merchant account
amount_refunded
integer
| int32
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
Required
method of payment
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
google_map_point
object
google map point of location
landmark
string
landmark
phone
string
Required
phone number
country_iso_code
string
Required
country's code name e.g. `IN`, `GB`
area_code
string
Required
customer pin/zip code
country
string
Required
country name
expire_at
string
address expiry timestamp
geo_location
object
location latitude and logitude
state
string
Required
state of the customer
area
string
Required
area details
g_address_id
string
Required
unique address id generated by Fynd platform
area_code_slug
string
Required
area slug code, use pin or zip code if not available
country_phone_code
string
Required
country's phone code
name
string
Required
customer name
address_type
string
Nullable
address type e.g. home, office
address
string
Required
address details
email
string
customer email
city
string
Required
city name
tags
array of object
optional address tag
captured
boolean
whether the payment is captured (credited to merchant account) by payment gateway.
meta
object
Metadata
status
string
Required
stautus of the payment
total_amount
integer
| int32
Required
The total amount refunded.
refund_details
array of object (RefundSessionDetail)
Required
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.
receipt_number
string
unique receipt for refund, generated by payment gateway, if not available can be utr.
pg_refund_id
string
unique identifier for refund, generated by payment gateway.
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
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
company_id:
1
application_id:
"64bf81dcc07acacc135733ea"
gid:
"FY615DE25839C4AF3A1A"
request_id:
"16100144824381402124"
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}
Loading...
Response
Loading...