Payment

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

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
PUT
/service/platform/payment/v1.0/company/{company_id}/payouts
# Update payout.
PATCH
/service/platform/payment/v1.0/company/{company_id}/payouts
# Activate/Deactivate payout.
DEL
/service/platform/payment/v1.0/company/{company_id}/payouts
# Delete payout.
GET
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
# Get All Payouts
POST
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
# Save Payout
PUT

Update payout.

Modify the details of a payout transaction.
Requires company/finance/write access scope.
Parameters
company_id
integer
Required
Company Id
Request body
aggregator
string
Required
Aggregator Name
users
object (PayoutUserDetails)
Required
PayoutUserDetails
unique_external_id
string
name
string
email
string
mobile
string
unique_external_id
string
Required
Unique Id of Payout
is_active
boolean
Required
Enable or Disable Flag Payout
bank_details
object (PayoutBankDetails)
Required
PayoutBankDetails
ifsc_code
string
Required
account_holder
string
state
string
country
string
account_type
string
Required
account_no
string
city
string
bank_name
string
branch_name
string
pincode
integer
| int32
transfer_type
string
Required
transafer type
Response
200
save payout response object
UpdatePayoutDetails
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Enable or DIsable Flag Payout
success
boolean
Response is successful or not
bank_details
object (PayoutBankDetails)
PayoutBankDetails
ifsc_code
string
account_holder
string
state
string
country
string
account_type
string
account_no
string
city
string
bank_name
string
branch_name
string
pincode
integer
| int32
transfer_type
string
aggregator
string
users
object (PayoutUserDetails)
PayoutUserDetails
unique_external_id
string
name
string
email
string
mobile
string
unique_transfer_no
string
updated
boolean
payment_status
string
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
Examples
Parameters
company_id:
1
body:
body
PUT
/service/platform/payment/v1.0/company/{company_id}/payouts
Loading...
Response
Loading...
PATCH

Activate/Deactivate payout.

Enable or disable payout functionality.
Requires company/finance/write access scope.
Parameters
company_id
integer
Required
Company Id
Request body
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Required
Enable or Disable Flag Payout
unique_external_id
string
Required
Unique Id of Payout
Response
200
save payout response object
UpdatePayoutDetails
is_default
boolean
Enable or Disable Default Payout
is_active
boolean
Enable or DIsable Flag Payout
success
boolean
Response is successful or not
bank_details
object (PayoutBankDetails)
PayoutBankDetails
ifsc_code
string
account_holder
string
state
string
country
string
account_type
string
account_no
string
city
string
bank_name
string
branch_name
string
pincode
integer
| int32
transfer_type
string
aggregator
string
users
object (PayoutUserDetails)
PayoutUserDetails
unique_external_id
string
name
string
email
string
mobile
string
unique_transfer_no
string
updated
boolean
payment_status
string
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
Examples
Parameters
company_id:
1
body:
body
PATCH
/service/platform/payment/v1.0/company/{company_id}/payouts
Loading...
Response
Loading...
DEL

Delete payout.

Remove a payout transaction from the system.
Requires company/finance/write access scope.
Parameters
company_id
integer
Required
Company Id
unique_transfer_no
string
Required
Unique transfer id
Response
200
delete payout response object
DeletePayoutDetails
delete
boolean
delete is successful or not
unique_transfer_no
string
unique transafer no of payout
success
boolean
Response is successful or not
Examples
Parameters
company_id:
1
unique_transfer_no:
"123232321"
DEL
/service/platform/payment/v1.0/company/{company_id}/payouts
Loading...
Response
Loading...
GET

Get All Payouts

Get All Payouts
Requires company/finance/read access scope.
Parameters
company_id
integer
Required
Company Id
unique_transfer_no
string
Required
Unique transfer id
unique_external_id
string
Fetch payouts using unique external id
Response
200
payouts response object
PayoutsDetails
success
boolean
Response is successful or not
items
array of object (Payout)
contains list of PayoutSchema
Array of Payout
customers
object (PayoutCustomer)
PayoutCustomer
unique_external_id
string
Nullable
unique_external_id
mobile
string
Nullable
Customer Mobile No
name
string
Nullable
Customer Name
email
string
Nullable
Customer Email
id
integer
| int32
Nullable
Customer ID
more_attributes
object (PayoutMoreAttributes)
PayoutMoreAttributes
branch_name
string
Nullable
Branch Name
city
string
Nullable
City
account_no
string
Nullable
Account Number
country
string
Nullable
Country
state
string
Nullable
State
account_holder
string
Nullable
Account Holder Name
ifsc_code
string
Nullable
IFSC Code
account_type
string
Nullable
Account Type Saving or Current
bank_name
string
Nullable
Name of Bank
is_default
boolean
default or not
payouts_aggregators
array of object (PayoutAggregator)
Array of PayoutAggregator
aggregator_id
integer
| int32
Nullable
aggregator_id
aggregator_fund_id
integer
| int32
Nullable
aggregator_fund_id
payout_details_id
integer
| int32
Nullable
payout_details_id
unique_transfer_no
string
display priority of the payment mode
is_active
boolean
Enable/DIsable Flag Payout
transfer_type
string
transafer type
Examples
Parameters
company_id:
1
unique_transfer_no:
"12323232"
unique_external_id:
"12323232"
GET
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
Loading...
Response
Loading...
POST

Save Payout

Save Payout
Requires company/finance/write access scope.
Parameters
company_id
integer
Required
Company Id
unique_transfer_no
string
Required
Unique transfer id
Request body
aggregator
string
Required
Aggregator Name
users
object (PayoutUserDetails)
Required
PayoutUserDetails
unique_external_id
string
name
string
email
string
mobile
string
unique_external_id
string
Required
Unique Id of Payout
is_active
boolean
Required
Enable or Disable Flag Payout
bank_details
object (PayoutBankDetails)
Required
PayoutBankDetails
ifsc_code
string
Required
account_holder
string
state
string
country
string
account_type
string
Required
account_no
string
city
string
bank_name
string
branch_name
string
pincode
integer
| int32
transfer_type
string
Required
transafer type
Response
200
400
save payout response object
PayoutDetails
payment_status
string
status of payment
users
object (PayoutUserDetails)
PayoutUserDetails
unique_external_id
string
name
string
email
string
mobile
string
aggregator
string
Aggregator Name
unique_transfer_no
string
unique transfer no
is_active
boolean
Enable or DIsable Flag Payout
bank_details
object (PayoutBankDetails)
PayoutBankDetails
ifsc_code
string
account_holder
string
state
string
country
string
account_type
string
account_no
string
city
string
bank_name
string
branch_name
string
pincode
integer
| int32
success
boolean
Response is successful or not
transfer_type
string
transfer type
created
boolean
created flag
payouts
object (PayoutData)
PayoutData
more_attributes
object (BankDetails)
BankDetails
account_type
string
city
string
account_holder
string
branch_name
string
account_no
string
bank_name
string
country
string
state
string
ifsc_code
string
aggregator_fund_id
string
aggregator_fund_id
string
Nullable
Examples
Parameters
company_id:
1
unique_transfer_no:
"1232323221"
body:
body
POST
/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}
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}/payment/methods/configs
# List Payment Method Configs
GET

List Payment Method Configs

Get all active List Payment Method Configs
Requires company/finance/read access scope.
Parameters
company_id
integer
Required
Company Id
Response
200
List Order Beneficiary
PaymentMethodConfigDetails
success
boolean
refund_to
object (RefundTo)
Nullable
RefundTo
source
string
others
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
required_session_paths
array of object (RequiredSessionPath)
Array of RequiredSessionPath
version
string
paths
array of object (SessionItem)
Array of SessionItem
type
string
uri_path
string
content_type
string
methods
array of string
payment_methods
array of object (PaymentMode)
Array of PaymentMode
id
integer
priority
integer
name
string
code
string
display_name
string
slug
string
is_active
boolean
merchant_transaction_id
string
amount
number
| float
payment_id
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
name
string
display_name
string
code
string
priority
integer
is_active
boolean
logo
string
logos
object (PaymentModeLogo)
PaymentModeLogo
large
string
| url
large
small
string
| url
smalll
checkout_type
array of object (CheckoutType)
Array of CheckoutType
name
string
slug
string
auto_capture
array of boolean
mode
array of object (Mode)
Array of Mode
name
string
slug
string
country
array of object (Country)
Array of Country
name
string
slug
string
currency
array of object (Currency)
Array of Currency
name
string
slug
string
Examples
Parameters
Parameters are not required.
GET
/service/platform/payment/v1.0/company/{company_id}/payment/methods/configs
Loading...
Response
Loading...