Skip to main content

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}/aggregator/request
# Get secrets for brand payment gateway
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregator/request
# Save brand payment gateway config
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}/
# Get OAuth URL
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}/
# Revoke OAuth token
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator
# Get merchant aggregator payment mode
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/version
# Get app version for Aggregator
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/version
# Update app version for Aggrgator
GET

Get secrets for brand payment gateway

Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways.
Parameters
aggregator
string
Optional
aggregator slug
configType
string
Optional
Enum
Response
200
400
500
Refund Transfer Mode
PaymentGatewayConfigResponse
aggregators
array of object
Optional
List of all speceific Payment options with their Details.
app_id
string
Application Id to which Payment config Mapped
excluded_fields
array of string
List of all excluded options with their Details.
success
boolean
Response is successful or not
created
boolean
Response is created or not
display_fields
array of string
List of all included options with their Details.
Examples
Parameters
aggregator:
"value"
configType:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregator/request
Loading...
Response
Loading...
POST

Save brand payment gateway config

Store and update configuration settings for brand payment gateways i.e required for payment for a payment gateway like key, secret, merchant salt.
Parameters
body
object (PaymentGatewayConfigRequest)
PaymentGatewayConfigRequest
app_id
string
Application Id to which Payment config Mapped
is_active
boolean
Nullable
Optional
Enable or Disable Flag
aggregator_name
object (PaymentGatewayConfig)
Optional
PaymentGatewayConfig
Response
200
400
500
Save Config Secret For Brand Payment Gateway Success Response.
PaymentGatewayToBeReviewed
aggregator
array of string
List of added payment gateway
success
boolean
Response is successful or not
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregator/request
Loading...
Response
Loading...
GET

Get OAuth URL

This has been used when merchant is setup their razorpay payment gateway, they will redirect to razorpay site after submitting all their secrets for authetication.
Parameters
aggregator
string
aggregator
successRedirectUrl
string
Optional
This is the url which will come back to after success authorization complete
failureRedirectUrl
string
Optional
This is the url which will come back to after failure authorization
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `GetOauthUrlResponseSchema` for more details.
GetOauthUrlResponse
url
string
The url to call for authenticating
success
boolean
Response is successful or not
Examples
Parameters
aggregator:
"value"
successRedirectUrl:
"value"
failureRedirectUrl:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}/
Loading...
Response
Loading...
POST

Revoke OAuth token

Revoke the creds for payment aggregator razropay.
Parameters
aggregator
string
aggregator_slug
Response
200
400
500
Success. Returns the status of revokation. Check the example shown below or refer `RevokeOAuthTokenSchema` for more details.
RevokeOAuthToken
message
string
The confirmation message of the token revoke.
success
boolean
Response is successful or not
Examples
Parameters
aggregator:
"value"
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}/
Loading...
Response
Loading...
GET

Get merchant aggregator payment mode

Get payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes.
Parameters
No Parameters
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator
Loading...
Response
Loading...
GET

Get app version for Aggregator

Get app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app.
Parameters
aggregatorId
integer
Aggregators Id
businessUnit
string
device
string
paymentModeId
integer
Optional
subPaymentMode
string
Optional
Response
200
400
500
Success.
AggregatorVersionResponse
message
string
Message
success
boolean
Successful or failure
items
object (AggregatorVersionItemSchema)
Optional
AggregatorVersionItemSchema
Examples
Parameters
aggregatorId:
1
businessUnit:
"storefront"
device:
"desktop"
paymentModeId:
3
subPaymentMode:
"LAVB_R"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/version
Loading...
Response
Loading...
PATCH

Update app version for Aggrgator

Update app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app.
Parameters
aggregatorId
integer
Aggregators Id
body
object (AggregatorControlRequest)
AggregatorControlRequest
business_unit
string
Optional
Business unit
items
array of object
Optional
List of item details with respect to payment_mode
device
string
Optional
Device name
version
object (AggregatorVersionRequestSchema)
Optional
AggregatorVersionRequestSchema
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
aggregatorId:
1
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/version
Loading...
Response
Loading...

Cash on Delivery

Cash on Delivery (COD) refers to a payment method where customers have the option to pay for their purchases with cash at the time of delivery, rather than making a payment online or in advance. With COD, customers can place an order online and then pay the delivery person in cash when the products are delivered to their doorstep. cod functionality controls from the platform for specific and all users as well.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/user-cod
# Get user COD
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/user-cod
# Set user COD
GET

Get user COD

Retrieve user cod limt data of user i.e cod is active or not for user and remaining limit
Parameters
merchantUserId
string
mobileNo
string
Response
200
400
500
Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
GetUserCODLimitResponse
user_cod_data
object (CODdata)
CODdata
success
boolean
Response is successful or not
Examples
Parameters
merchantUserId:
"value"
mobileNo:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/user-cod
Loading...
Response
Loading...
PUT

Set user COD

This allows access to seller to enable disable cod of specific user
Parameters
body
object (SetCODForUserRequest)
Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.
SetCODForUserRequest
mobileno
string
Mobile No. of User
is_active
boolean
either true or false
merchant_user_id
string
Merchant User id
Response
200
400
500
Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
SetCODOptionResponse
message
string
Message
success
boolean
Response is successful or not
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/user-cod
Loading...
Response
Loading...

EDC Device

An Electronic Data Capture (EDC) device, also known as a card machine, card reader, or POS (Point of Sale) terminal, is a handheld electronic device used to process payments made with credit or debit cards. EDC devices are commonly used by businesses to securely accept card payments from customers at the point of sale.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-aggregator-list
# EDC aggregators and model list
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-stats
# EDC device stats
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device
# Update EDC device
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device/{terminal_unique_identifier}
# Get an EDC device
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device/{terminal_unique_identifier}
# Create an EDC device
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-list
# List EDC devices
GET

EDC aggregators and model list

Retrieve a list of EDC (Electronic Data Capture) aggregators and models.
Parameters
No Parameters
Response
200
400
500
Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcAggregatorAndModelListResponseSchema` for more details.
EdcAggregatorAndModelListResponse
data
array of object (EdcModelData)
List of aggregators and their edc models
Array of EdcModelData
success
boolean
Response is successful or not
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-aggregator-list
Loading...
Response
Loading...
GET

EDC device stats

Information about EDC (Electronic Data Capture) devices linked to a specific application within a company. It provides statistics such as the count of active and inactive devices.
Parameters
No Parameters
Response
200
400
500
Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcDeviceStatsResponseSchema` for more details.
EdcDeviceStatsResponse
statistics
object (StatisticsData)
StatisticsData
success
boolean
Response is successful or not
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-stats
Loading...
Response
Loading...
POST

Update EDC device

Enables the modification of settings and details associated with an Electronic Data Capture (EDC) device linked to a specific application within a company. Upon success, it returns the updated information of the EDC device.
Parameters
body
object (EdcAddRequest)
Check the example of a request body below or refer `EdcAddRequestSchema` for more details.
EdcAddRequest
edc_model
string
Model of the edc machine
store_id
integer
| int32
Store at which devices is to used
aggregator_id
integer
| int32
Aggregator which will accept payment
edc_device_serial_no
string
Serial number or imei of EDC device
Maximum Length : 20
terminal_serial_no
string
Device serial number of terminal(android tablet)
Maximum Length : 20
device_tag
string
Nullable
Optional
Device tag of edc device to identify it
Maximum Length : 50
Response
200
400
500
Success. Returns the single edc device mapped to the terminal. Check the example shown below or refer `EdcDeviceAddResponseSchema` for more details.
EdcDeviceAddResponse
data
object (EdcDevice)
EdcDevice
success
boolean
Response is successful or not
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device
Loading...
Response
Loading...
GET

Get an EDC device

Retrieve comprehensive details regarding an Electronic Data Capture (EDC) device associated with a particular terminal unique identifier within a company's application.Upon success, it returns the detailed information of the EDC device, including terminal serial number, EDC device serial number, merchant store POS code, store ID, aggregator ID and name, device tag, activation status, and EDC model.
Parameters
terminalUniqueIdentifier
string
Terminal unique identifier
Response
200
400
500
Success. Returns the single edc device mapped to the terminal. Check the example shown below or refer `EdcDeviceDetailsResponseSchema` for more details.
EdcDeviceDetailsResponse
data
object (EdcDevice)
EdcDevice
success
boolean
Response is successful or not
Examples
Parameters
terminalUniqueIdentifier:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device/{terminal_unique_identifier}
Loading...
Response
Loading...
PUT

Create an EDC device

Registration and addition of a new EDC device to the system
Parameters
terminalUniqueIdentifier
string
Terminal unique identifier
body
object (EdcUpdateRequest)
Check the example of a request body below or refer `EdcUpdateRequestSchema` for more details.
EdcUpdateRequest
edc_model
string
Optional
Model of the edc machine
store_id
integer
| int32
Optional
Store at which devices is to used
aggregator_id
integer
| int32
Optional
Aggregator which will accept payment
edc_device_serial_no
string
Optional
Serial number or imei of EDC device
Maximum Length : 20
is_active
boolean
Optional
State whether device is active or inactive
merchant_store_pos_code
string
Optional
This is provided by pinelabs
Maximum Length : 10
device_tag
string
Nullable
Optional
Device tag of edc device to identify it
Maximum Length : 50
Response
200
400
500
Check the example shown below or refer `EdcDeviceUpdateResponseSchema` for more details.
EdcDeviceUpdateResponse
success
boolean
Response is successful or not
Examples
Parameters
terminalUniqueIdentifier:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device/{terminal_unique_identifier}
Loading...
Response
Loading...
GET

List EDC devices

Retrieves a list of available Electronic Data Capture (EDC) devices.
Parameters
pageNo
integer
Optional
pageSize
integer
Optional
isActive
boolean
Optional
storeId
integer
Optional
deviceTag
string
Optional
Response
200
400
500
Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcDeviceListResponseSchema` for more details.
EdcDeviceListResponse
items
array of object (EdcDevice)
List of all edc mapped to the application options with their Details.
Array of EdcDevice
page
object (Page)
Page
success
boolean
Response is successful or not
Examples
Parameters
pageNo:
0
pageSize:
0
isActive:
false
storeId:
0
deviceTag:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-list
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
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options
# Get payment modes
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm
# Payment confirmation
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/pos
# List POS payment modes
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/request
# Start payment process
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm/polling
# Poll and update payment status
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/cancel
# Resend or cancel payment
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk/
# Retrieve status of multiple payments in bulk
GET

Get payment modes

Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'.
Parameters
refresh
boolean
requestType
string
orderId
string
Optional
shipmentId
string
Optional
Response
200
400
500
Success
PaymentOptionsResponse
payment_options
object (PaymentOptions)
PaymentOptions
success
boolean
Response is successful or not
payment_breakup
object
Optional
Payment Breakup for advance payment
Examples
Parameters
refresh:
false
requestType:
"value"
orderId:
"value"
shipmentId:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options
Loading...
Response
Loading...
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
body
object (PaymentConfirmationRequest)
Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.
PaymentConfirmationRequest
order_id
string
Unique order id
payment_methods
array of object (MultiTenderPaymentMethod)
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
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm
Loading...
Response
Loading...
GET

List POS payment modes

Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'.
Parameters
amount
integer
Payable amount.
cartId
string
Optional
Identifier of the cart.
pincode
string
The PIN Code of the destination address, e.g. 400059
checkoutMode
string
Optional
Option to checkout for self or for others.
refresh
boolean
Optional
This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one.
orderId
string
Optional
cardReference
string
Optional
Card reference id of user's debit or credit card.
orderType
string
The order type of shipment * HomeDelivery - If the customer wants the order home-delivered * PickAtStore - If the customer wants the handover of an order at the store itself.
userDetails
string
Optional
URIencoded JSON containing details of an anonymous user.
displaySplit
boolean
Optional
Display Split Payment Option or not
advancePayment
boolean
Optional
Display Advance Payment Options or Normal
shipmentId
string
Optional
Response
200
400
500
Success
PaymentModeRouteResponse
payment_options
object (PaymentOptionAndFlow)
PaymentOptionAndFlow
success
boolean
Response is successful or not
payment_breakup
object
Optional
Payment Breakup for advance payment
advance_payment
array of object (AdvancePaymentObject)
Nullable
Optional
Advance Payment Array
Array of AdvancePaymentObject
Examples
Parameters
amount:
0
cartId:
"value"
pincode:
"value"
checkoutMode:
"value"
refresh:
false
orderId:
"value"
cardReference:
"value"
orderType:
"value"
userDetails:
"value"
displaySplit:
false
advancePayment:
false
shipmentId:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/pos
Loading...
Response
Loading...
POST

Start payment process

Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID.
Parameters
body
object (PaymentInitializationRequest)
Check the example of a request body below or refer `PaymentInitializationRequest` for more details.
PaymentInitializationRequest
razorpay_payment_id
string
Nullable
Optional
Payment gateway payment id
device_id
string
Nullable
Optional
EDC machine Unique Identifier
email
string
| email
Customer valid email
customer_id
string
Payment gateway customer id.
vpa
string
Nullable
Optional
Customer vpa address
aggregator
string
Payment gateway name
order_id
string
Payment gateway order id
currency
string
Currency code.
amount
integer
| int32
Nullable
Payable amount.
contact
string
Customer valid mobile number
timeout
integer
| int32
Nullable
Optional
Payment polling timeout if not recieved response
merchant_order_id
string
Unique fynd order id
method
string
Payment method
Response
200
400
500
Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.
PaymentInitializationResponse
razorpay_payment_id
string
Nullable
Optional
Payment id.
device_id
string
Nullable
Optional
EDC machine Unique Identifier
upi_poll_url
string
Nullable
Optional
UPI poll url.
customer_id
string
Nullable
Optional
Payment gateway customer id.
polling_url
string
Polling url.
vpa
string
Nullable
Optional
Customer vpa address
aggregator
string
Payment gateway name
currency
string
Nullable
Optional
Currency code.
merchant_order_id
string
order id
amount
integer
| int32
Nullable
Optional
Payable amount.
timeout
integer
| int32
Nullable
Optional
timeout.
virtual_id
string
Nullable
Optional
Payment virtual address.
bqr_image
string
Nullable
Optional
Bharath qr image url.
aggregator_order_id
string
Optional
Payment order id
success
boolean
Response is successful or not.
status
string
Optional
Status of payment.
method
string
Payment method
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/request
Loading...
Response
Loading...
POST

Poll and update payment status

Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions.
Parameters
body
object (PaymentStatusUpdateRequest)
Check the example of a request body below or refer `PaymentStatusUpdateRequest` for more details.
PaymentStatusUpdateRequest
device_id
string
Nullable
Optional
EDC machine Unique Identifier
email
string
| email
Customer valid email
customer_id
string
Payment gateway customer id.
vpa
string
Optional
Customer vpa address
aggregator
string
Payment gateway name
order_id
string
Payment gateway order id
currency
string
Currency code.
amount
integer
| int32
Nullable
Payable amount.
contact
string
Customer valid mobile number
merchant_order_id
string
Unique fynd order id
status
string
Status of payment.
method
string
Payment method
merchant_transaction_id
string
Unique fynd transaction id
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.
PaymentStatusUpdateResponse
redirect_url
string
Nullable
Optional
Redirect url
retry
boolean
Response is successful or not.
success
boolean
Nullable
Optional
Response is successful or not
status
string
Payment status
aggregator_name
string
Payment gateway name
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm/polling
Loading...
Response
Loading...
POST

Resend or cancel payment

Enable you to perform actions related to the resending and cancellation of payment links through SMS or EMAIL. resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing.
Parameters
body
object (ResendOrCancelPaymentRequest)
Check the example of a request body below or refer `ResendOrCancelPaymentRequest` for more details.
ResendOrCancelPaymentRequest
order_id
string
Unique order id
device_id
string
Nullable
Optional
EDC machine Unique Identifier
request_type
string
Either resend or cancel
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `ResendOrCancelPaymentResponse` for more details.
ResendOrCancelPaymentResponse
data
object (LinkStatus)
LinkStatus
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/cancel
Loading...
Response
Loading...
POST

Retrieve status of multiple payments in bulk

Retrieve status of multiple payments in bulk and returns the status of each payment along with associated details such as payment ID, amount, currency, status, payment mode, and payment gateway in the response
Parameters
body
object (PaymentStatusBulkHandlerRequest)
Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.
PaymentStatusBulkHandlerRequest
merchant_order_id
array of string
List of order ids
Response
200
400
500
Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.
PaymentStatusBulkHandlerResponse
count
integer
| int32
Optional
data
array of object (PaymentStatusObject)
Optional
Array of PaymentStatusObject
success
string
error
string
Optional
status
integer
| int32
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk/
Loading...
Response
Loading...

Paylater

PayLater, also known as "Buy Now, Pay Later" (BNPL), is a payment method that allows customers to make purchases and defer payment for those purchases to a later date. With PayLater, customers can buy products or services immediately and then repay the amount owed over time, typically in installments.Efficiently Retrieve Repayment Transaction Details, Initiate Merchant Onboarding for BNPL, and Validate Customer Eligibility for Paylater Payment Options.

Operations
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/repayment-details
# Repayment details for BNPL
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/merchant-onboarding
# Merchant onboarding for BNPL
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/customer/validation
# Validate customer for paylater
POST

Repayment details for BNPL

Retrieve repayment details for Buy Now Pay Later (BNPL) payment
Parameters
body
object (RepaymentDetailsSerialiserPayAll)
Check the example of a request body below.
RepaymentDetailsSerialiserPayAll
total_amount
number
| float
total amount
extension_order_id
string
Nullable
Order id created in extension
aggregator_transaction_id
string
Unique Id for the transaction
aggregator_order_id
string
Id of payment gateway
shipment_details
array of object (RepaymentRequestDetails)
Optional
Array of RepaymentRequestDetails
Response
200
400
500
Success. Returns the status of API. Check the example shown below or refer `RepaymentResponseSchema` for more details.
RepaymentResponse
data
object
success
boolean
Success/Failure of the transaction
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/repayment-details
Loading...
Response
Loading...
POST

Merchant onboarding for BNPL

Initiate the merchant onboarding process for Buy Now Pay Later (BNPL).
Parameters
body
object (MerchantOnBoardingRequest)
Check the example of a request body below.
MerchantOnBoardingRequest
credit_line_id
string
Merchant ID at Ajiodhan's end
aggregator
string
Payment aggregator name
app_id
string
Application id
user_id
string
Deadlock or Grimlock user id
status
string
Status
Response
200
400
500
Success. Returns the status of API. Check the example shown below or refer `RepaymentResponseSchema` for more details.
MerchantOnBoardingResponse
data
object
success
boolean
Success/Failure of the transaction
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/merchant-onboarding
Loading...
Response
Loading...
POST

Validate customer for paylater

Verify whether the user is eligible for pay-later payment from the payment aggregator's side using the customer's phone number
Parameters
body
object (ValidateCustomerRequest)
Pass the payload, payment aggregator, phone number and other details in the request body as shown below.
ValidateCustomerRequest
phone_number
string
User mobile number without country code.
aggregator
string
Payment gateway name in camel case i.e Simpl, Rupifi
payload
string
Nullable
Optional
Hashed payload string.
delivery_address
object
Optional
Extra meta fields.
transaction_amount_in_paise
integer
| int32
Payable amount in paise
order_items
array of object
Optional
Extra meta fields.
merchant_params
object
Optional
Extra meta fields.
billing_address
object
Optional
Extra meta fields.
Response
200
400
500
Success. Check the example shown below or refer `ValidateCustomerResponse` for more details.
ValidateCustomerResponse
message
string
Error or success message.
data
object
Payment gateway response data
success
boolean
Response is successful or not
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/customer/validation
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
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders/
# Create Order
GET

Get payment session

Allows users to fetch the payment session details associated with a given order ID or transaction ID
Parameters
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.
lineItem
boolean
Optional
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
Optional
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)
Optional
CartDetailsSerializer
refund_details
array of object (RefundDetailsSerializer)
object of refund details
Array of RefundDetailsSerializer
Examples
Parameters
gid:
"value"
lineItem:
false
Was this section helpful?
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
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.
body
object (PaymentSessionRequestSerializer)
Check the example of a request body below or refer `PaymentSessionRequestSerializer` for more details
PaymentSessionRequestSerializer
meta
object
Optional
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.
order_details
object (OrderDetail)
The details of the order.
OrderDetail
status
string
status of the payment.
currency
string
currency of the payment.
payment_details
array of object (PaymentSessionDetail)
The payment details with the schema `PaymentSessionDetail`.
Array of PaymentSessionDetail
total_amount
integer
| int32
amount paid.
checksum
string
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
gid:
"FY615DE25839C4AF3A1A"
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}
Loading...
Response
Loading...
POST

Create Order

Create an order and payment on the aggregator side
Parameters
body
object (PaymentOrderRequest)
Pass the details in the request body as shown below.
PaymentOrderRequest
order_id
string
Order id
payment_methods
array of object (PaymentOrderMethods)
Optional
Array of PaymentOrderMethods
shipment_id
string
Optional
shipment_id
Response
200
400
500
Success. Check the example shown below
PaymentOrderResponse
message
string
Message
success
boolean
Successful or failure
payment_confirm_url
string
Nullable
Optional
Payment confirm url for aggregator
callback_url
string
Nullable
Optional
Callback url for aggregator
status_code
integer
| int32
HTTP status code
order_id
string
Nullable
Optional
Merchant order id
data
object (PaymentOrderData)
Optional
PaymentOrderData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders/
Loading...
Response
Loading...

Payout

Payout refers to the process of disbursing funds to sellers or vendors for products or services sold through the platform. Here's a breakdown of the operations related to payout: Adding Bank Details: This operation involves sellers providing their bank account information, such as account number and routing number, to receive payouts for their sales. This information is securely stored in the platform's database. Deleting Bank Details: Sellers may need to update or remove their bank account information for various reasons, such as changing banks or updating account details. The platform allows sellers to delete their existing bank details when needed. Retrieving Bank Details: Sellers can retrieve their stored bank details from the platform to review or verify the information. This ensures transparency and accuracy in the payout process. Updating Bank Details: Sellers have the option to update their bank account information if there are any changes or corrections required. This operation allows sellers to ensure that their payout information is up to date and accurate. Overall, payout operations facilitate the smooth transfer of funds from the platform to sellers, enabling them to receive payment for their sales efficiently and securely.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/payouts
# List payouts
POST
/service/platform/payment/v1.0/company/{company_id}/payouts
# Save payout
PUT
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
# Update payout
PATCH
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
# Activate/Deactivate payout
DEL
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
# Delete payout
GET

List payouts

Retrieve a list of all payout transactions.
Parameters
uniqueExternalId
string
Optional
Fetch payouts using unique external id
Response
200
400
500
payouts response object
PayoutsResponse
success
boolean
Response is successful or not
items
array of object (Payout)
contains list of PayoutSchema
Array of Payout
Examples
Parameters
uniqueExternalId:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/payouts
Loading...
Response
Loading...
POST

Save payout

Store and process a payout transaction.
Parameters
body
object (PayoutRequest)
PayoutRequest
aggregator
string
Aggregator Name
users
object
payout users object
unique_external_id
string
Unique Id of Payout
is_active
boolean
Enable or Disable Flag Payout
bank_details
object (PayoutBankDetails)
PayoutBankDetails
transfer_type
string
transafer type
Response
200
400
500
save payout response object
PayoutResponse
payment_status
string
status of payment
users
object
users details object
aggregator
string
Aggregator Name
unique_transfer_no
string
unique transfer no
is_active
boolean
Enable or DIsable Flag Payout
bank_details
object
payout bank_details object
success
boolean
Response is successful or not
transfer_type
string
transfer type
created
boolean
created flag
payouts
object
payout object
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/payouts
Loading...
Response
Loading...
PUT

Update payout

Modify the details of a payout transaction.
Parameters
uniqueTransferNo
string
Unique transfer id
body
object (PayoutRequest)
PayoutRequest
aggregator
string
Aggregator Name
users
object
payout users object
unique_external_id
string
Unique Id of Payout
is_active
boolean
Enable or Disable Flag Payout
bank_details
object (PayoutBankDetails)
PayoutBankDetails
transfer_type
string
transafer type
Response
200
400
500
save payout response object
UpdatePayoutResponse
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Enable or DIsable Flag Payout
success
boolean
Response is successful or not
Examples
Parameters
uniqueTransferNo:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
Loading...
Response
Loading...
PATCH

Activate/Deactivate payout

Enable or disable payout functionality.
Parameters
uniqueTransferNo
string
Unique transfer id
body
object (UpdatePayoutRequest)
UpdatePayoutRequest
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Enable or Disable Flag Payout
unique_external_id
string
Unique Id of Payout
Response
200
400
500
save payout response object
UpdatePayoutResponse
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Enable or DIsable Flag Payout
success
boolean
Response is successful or not
Examples
Parameters
uniqueTransferNo:
"value"
body:
body
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
Loading...
Response
Loading...
DEL

Delete payout

Remove a payout transaction from the system.
Parameters
uniqueTransferNo
string
Unique transfer id
Response
200
400
500
delete payout response object
DeletePayoutResponse
success
boolean
Response is successful or not
Examples
Parameters
uniqueTransferNo:
"value"
Was this section helpful?
DEL
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
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}/ifsc-code/verify
# Verify IFSC code
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
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
# Get merchant refund priority
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
# Create merchant refund priority
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
# Update merchant refund priority
GET

Get bank account details

Retrieve bank account information
Parameters
orderId
string
requestHash
string
Optional
Response
200
400
500
Success
RefundAccountResponse
is_verified_flag
boolean
Optional
message
string
Response message
data
object
Optional
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
orderId:
"value"
requestHash:
"value"
Was this section helpful?
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
body
object (AddBeneficiaryDetailsOTPRequest)
AddBeneficiaryDetailsOTPRequest
order_id
string
details
object (BankDetailsForOTP)
BankDetailsForOTP
Response
200
400
500
Success
RefundAccountResponse
is_verified_flag
boolean
Optional
message
string
Response message
data
object
Optional
Refund account data.
success
boolean
Success or failure flag.
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account
Loading...
Response
Loading...
GET

Verify IFSC code

Checks the validity of the provided IFSC code and returns bank details if valid.
Parameters
ifscCode
string
Optional
Fetch bank details for correct ifsc code
Response
200
400
500
Bank details on correct Ifsc Code
IfscCodeResponse
branch_name
string
Branch Name Of Account
success
boolean
Optional
Response is successful or not
bank_name
string
Bank Name Of Account
Examples
Parameters
ifscCode:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/ifsc-code/verify
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
orderId
string
Response
200
400
500
List Order Beneficiary
OrderBeneficiaryResponse
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
Optional
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
show_beneficiary_details
boolean
Optional
Show beneficiary details or not.
Examples
Parameters
orderId:
"value"
Was this section helpful?
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
orderId
string
Response
200
400
500
List User Beneficiary
OrderBeneficiaryResponse
beneficiaries
array of object (OrderBeneficiaryDetails)
Nullable
Optional
All Beneficiaries Of An Order
Array of OrderBeneficiaryDetails
show_beneficiary_details
boolean
Optional
Show beneficiary details or not.
Examples
Parameters
orderId:
"value"
Was this section helpful?
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
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.
requestId
string
A unique id that was used to initiate a refund session. This is generated by Fynd platform and is usually shipment_id.
body
object (RefundSessionRequestSerializer)
Check the example of a request body below or refer `RefundSessionRequestSerializer` for more details
RefundSessionRequestSerializer
meta
object
Optional
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.
status
string
The status of the refund.
currency
string
The currency of the payment.
payment_details
object (PaymentSessionDetail)
details of the payment
PaymentSessionDetail
total_amount
integer
| int32
The total amount refunded.
refund_details
array of object (RefundSessionDetail)
details of the refund
Array of RefundSessionDetail
error
object (ErrorDescription)
Optional
ErrorDescription
message
string
Optional
The status of the refund.
checksum
string
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
gid:
"FY615DE25839C4AF3A1A"
requestId:
"16100144824381402124"
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}
Loading...
Response
Loading...
GET

Get merchant refund priority

Retrieve merchant refund priority configurations, returning the status of the update and the refund sources priority with their descriptions and priorities.
Parameters
configType
string
configuration for merchant or customer
Enum
Response
200
400
500
Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.
RefundPriorityResponseSerializer
configuration
string
configuration for merchant or customer
success
boolean
success
apportion
boolean
apportion refund to multiple sources
refund_sources_priority
array of object (RefundSourcesPriority)
refund sources priority
Array of RefundSourcesPriority
message
string
Optional
message
Examples
Parameters
configType:
"merchant"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
Loading...
Response
Loading...
POST

Create merchant refund priority

Create merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation.
Parameters
configType
string
configuration for merchant or customer
Enum
body
object (RefundPriorityRequestSerializer)
Check the example of a request body below or refer `RefundPriorityRequestSerializer` for more details
RefundPriorityRequestSerializer
apportion
boolean
apportion refund to multiple sources
refund_sources_priority
array of object (RefundSourcesPriority)
refund sources priority
Array of RefundSourcesPriority
Response
200
400
500
Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.
RefundPriorityResponseSerializer
configuration
string
configuration for merchant or customer
success
boolean
success
apportion
boolean
apportion refund to multiple sources
refund_sources_priority
array of object (RefundSourcesPriority)
refund sources priority
Array of RefundSourcesPriority
message
string
Optional
message
Examples
Parameters
configType:
"merchant"
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
Loading...
Response
Loading...
PUT

Update merchant refund priority

Update merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation.
Parameters
configType
string
configuration for merchant or customer
Enum
body
object (RefundPriorityRequestSerializer)
Check the example of a request body below or refer `RefundPriorityRequestSerializer` for more details
RefundPriorityRequestSerializer
apportion
boolean
apportion refund to multiple sources
refund_sources_priority
array of object (RefundSourcesPriority)
refund sources priority
Array of RefundSourcesPriority
Response
200
400
500
Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.
RefundPriorityResponseSerializer
configuration
string
configuration for merchant or customer
success
boolean
success
apportion
boolean
apportion refund to multiple sources
refund_sources_priority
array of object (RefundSourcesPriority)
refund sources priority
Array of RefundSourcesPriority
message
string
Optional
message
Examples
Parameters
configType:
"merchant"
Was this section helpful?
PUT
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}
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/options/modes/{mode}
# Get offline/advance payment mode
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}
# Update offline payment mode
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}/custom-config
# Get advance payment custom configurations
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}/custom-config
# Update advance payment custom configurations
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/codes
# Get payment mode codes
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration
# Get merchant payment option
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration
# Update payment gateways and payment mode
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}
# Get merchant aggregator and their payment mode
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}
# Update merchant aggregator payment mode
GET

Get offline/advance payment mode

Get details of offline / advance payment mode like for cod offline payment mode get user level cod limit, order level cod limit, cod charge.
Parameters
mode
string
offline / advance modes to get the payment modes
Response
200
400
500
Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
mode:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}
Loading...
Response
Loading...
PATCH

Update offline payment mode

Update offline payment mode details for the merchant like update for cod offline payment mode get user level cod limit, order level cod limit, cod charge, enable/disable device for cod.
Parameters
mode
string
offline / advance payment mode
body
object (MerchantPaymentModeRequest)
offline / advance payment mode details will be passed which needs to update
MerchantPaymentModeRequest
business_unit
string
Business unit
items
array of object
List of item details with respect to payment_mode
device
object
List of devices and its activation status
Response
200
400
500
Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
mode:
"value"
body:
body
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}
Loading...
Response
Loading...
GET

Get advance payment custom configurations

Merchants to fetch detailed information regarding advance payment custom configurations tailored to their specific business needs. merchants can access settings such as customer restrictions, available payment modes for both pre-order and post-order transactions
Parameters
mode
string
offline / advance mode
Response
200
400
500
Success. Get Advance Payment Custom Configurations.
PaymentCustomConfigResponseSchema
success
boolean
message
string
items
array of object (PaymentModeCustomConfigSchema)
Array of PaymentModeCustomConfigSchema
Examples
Parameters
mode:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}/custom-config
Loading...
Response
Loading...
PATCH

Update advance payment custom configurations

Allows merchants to modify specific details of advance payment custom configurations tailored to their business requirements. By providing the company ID, application ID, and payment mode, merchants can update settings such as minimum order value, customer restrictions, and available payment modes for both pre-order and post-order transactions
Parameters
mode
string
offline / advance payment mode
body
object (PaymentCustomConfigRequestSchema)
offline / advance payment mode details will be passed which needs to update
PaymentCustomConfigRequestSchema
business_unit
string
The business unit to which the store belongs.
items
array of object (PaymentCustomConfigDetailsRequestSchema)
Array of PaymentCustomConfigDetailsRequestSchema
Response
200
400
500
Success.
PaymentCustomConfigResponseSchema
success
boolean
message
string
items
array of object (PaymentModeCustomConfigSchema)
Array of PaymentModeCustomConfigSchema
Examples
Parameters
mode:
"value"
body:
body
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}/custom-config
Loading...
Response
Loading...
GET

Get payment mode codes

Enables users to retrieve options for payment codes.users can access information such as payment method names, networks, and associated codes, facilitating seamless integration and management of payment modes
Parameters
No Parameters
Response
200
400
500
List Order Beneficiary
GetPaymentCodeResponse
data
object (GetPaymentCode)
GetPaymentCode
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/codes
Loading...
Response
Loading...
GET

Get merchant payment option

Retrieve available payment gateways and offline payment mode details for a merchant by providing company ID and application ID, returning a list of active payment gateways and their configurations, including online and offline options.
Parameters
No Parameters
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration
Loading...
Response
Loading...
PATCH

Update payment gateways and payment mode

Updated online/offline payment as active/inactive like disable offline payment mode will disable offline payment modes on checkout page on merchant's website
Parameters
body
object (MerchnatPaymentModeRequest)
MerchnatPaymentModeRequest
offline
object
Nullable
Optional
Details to be updated for online payment configuration.
online
object
Nullable
Optional
Details to be updated for offline payment configuration.
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration
Loading...
Response
Loading...
GET

Get merchant aggregator and their payment mode

Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown.
Parameters
aggregatorId
integer
Aggregators Id
businessUnit
string
device
string
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
aggregatorId:
0
businessUnit:
"value"
device:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}
Loading...
Response
Loading...
PATCH

Update merchant aggregator payment mode

update payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes.
Parameters
aggregatorId
integer
Aggregators Id
body
object (PlatformPaymentModeResponse)
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Response
200
400
500
Success.
PlatformPaymentModeResponse
message
string
Nullable
Optional
Message
items
array of object
Nullable
Optional
List of all aggregator and payment mode details.
success
boolean
Response is successful or not.
Examples
Parameters
aggregatorId:
0
body:
body
Was this section helpful?
PATCH
/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}
Loading...
Response
Loading...

Subscription Payment

Manage subscription-related payment methods and configurations. Retrieve subscription payment methods, delete payment methods, access subscription configuration details, and save subscription setup intents for a streamlined subscription payment process.

Operations
GET
/service/platform/payment/v1.0/company/{company_id}/subscription/methods
# Get subscription payment method
DEL
/service/platform/payment/v1.0/company/{company_id}/subscription/methods
# Delete subscription payment method
GET
/service/platform/payment/v1.0/company/{company_id}/subscription/configs
# Get subscription config
POST
/service/platform/payment/v1.0/company/{company_id}/subscription/setup/intent
# Save subscription setup intent
GET

Get subscription payment method

Retrieve payment methods for subscriptions.
Parameters
uniqueExternalId
string
Optional
Unique external id
Response
200
400
500
List Subscription Payment Method Response
SubscriptionPaymentMethodResponse
data
array of object
Subscription Payment Method Object
success
boolean
Response is successful or not
Examples
Parameters
uniqueExternalId:
"value"
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/subscription/methods
Loading...
Response
Loading...
DEL

Delete subscription payment method

Remove a payment method from subscription options.
Parameters
uniqueExternalId
string
paymentMethodId
string
Response
200
500
Delete Subscription Payment Method Response.
DeleteSubscriptionPaymentMethodResponse
success
boolean
Success or failure.
Examples
Parameters
uniqueExternalId:
"value"
paymentMethodId:
"value"
Was this section helpful?
DEL
/service/platform/payment/v1.0/company/{company_id}/subscription/methods
Loading...
Response
Loading...
GET

Get subscription config

Retrieve configuration settings for subscriptions.
Parameters
No Parameters
Response
200
400
500
List Subscription Config Response
SubscriptionConfigResponse
aggregator
string
Aggregator Name
config
object
Aggregator Config
success
boolean
Response is successful or not
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/payment/v1.0/company/{company_id}/subscription/configs
Loading...
Response
Loading...
POST

Save subscription setup intent

Store and process setup intent for subscriptions.
Parameters
body
object (SaveSubscriptionSetupIntentRequest)
SaveSubscriptionSetupIntentRequest
unique_external_id
string
Unique id i.e company:id
Response
200
400
500
Save Subscription Setup Intent Response.
SaveSubscriptionSetupIntentResponse
data
object
Subscription Payment Method Object
success
boolean
Response is successful or not
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/payment/v1.0/company/{company_id}/subscription/setup/intent
Loading...
Response
Loading...