Payment
The Payment module facilitates the management of partner payout
Operations
GET
# Fetch payment configs.
GET
# Fetch payment gatewats.
POST
# save payout details.
PATCH
# save payout details.
PUT
# update payout details.
DEL
# Fetch payment gatewats.
GET
# Fetch payment gatewats.
POST
# save payout details.
PATCH
# save payout details.
PUT
# update payout details.
DEL
# Fetch payment gatewats.
Parameters
organization_id
string
Required
organization_id
Response
200
Success Returns Payout details.
PaymentConfigDetails
success
boolean
refund_to
object (RefundTo)
Nullable
RefundTo
source
string
Refund credited to the original payment mode used by the user for the payment.
others
string
Refund credited to a different payment mode not originally used by the user for the payment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
payment_methods
array of object (PaymentMethod)
Array of PaymentMethod
id
integer
sub_payment_mode
array of object (SubPaymentMode)
Array of SubPaymentMode
code
string
name
string
logo
string
name
string
logos
object (Logos)
Logos
small
string
large
string
slug
string
required_session_paths
array of object (RequiredSessionPath)
Array of RequiredSessionPath
version
string
paths
array of object (SessionPath)
Array of SessionPath
type
string
uri_path
string
content_type
string
methods
array of string
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
organization_id:
"1"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
organization_id
unique_external_id
integer
Required
unique_external_id.
Response
200
Success Returns Payout details.
PayoutDetails
items
array of object (PayoutItem)
Array of PayoutItem
unique_transfer_no
string
more_attributes
object (MoreAttributes)
MoreAttributes
city
string
state
string
country
string
bank_name
string
ifsc_code
string
account_no
string
branch_name
string
account_type
string
account_holder
string
transfer_type
string
is_default
boolean
is_active
boolean
customers
object (Customers)
Customers
id
integer
name
string
mobile
string
email
string
unique_external_id
string
payouts_aggregators
array of object (PayoutsAggregator)
Array of PayoutsAggregator
payout_details_id
integer
aggregator_id
integer
aggregator_fund_id
string
Nullable
success
boolean
Examples
Parameters
organization_id:
"1"
unique_external_id:
1
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
organization_id
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
organization_id
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
body:
body
Was this section helpful?
PATCH
Response
Parameters
organization_id
string
Required
organization_id
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
body:
body
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
organization_id
unique_external_id
integer
Required
unique_external_id.
Response
200
Success Returns Payout details.
PayoutDetails
items
array of object (PayoutItem)
Array of PayoutItem
unique_transfer_no
string
more_attributes
object (MoreAttributes)
MoreAttributes
city
string
state
string
country
string
bank_name
string
ifsc_code
string
account_no
string
branch_name
string
account_type
string
account_holder
string
transfer_type
string
is_default
boolean
is_active
boolean
customers
object (Customers)
Customers
id
integer
name
string
mobile
string
email
string
unique_external_id
string
payouts_aggregators
array of object (PayoutsAggregator)
Array of PayoutsAggregator
payout_details_id
integer
aggregator_id
integer
aggregator_fund_id
string
Nullable
success
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response
Parameters
organization_id
string
Required
organization_id
unique_transfer_no
string
Required
unique_transfer_no
unique_external_id
integer
Required
unique_external_id.
Response
200
Success Returns Payout details.
PayoutDetails
items
array of object (PayoutItem)
Array of PayoutItem
unique_transfer_no
string
more_attributes
object (MoreAttributes)
MoreAttributes
city
string
state
string
country
string
bank_name
string
ifsc_code
string
account_no
string
branch_name
string
account_type
string
account_holder
string
transfer_type
string
is_default
boolean
is_active
boolean
customers
object (Customers)
Customers
id
integer
name
string
mobile
string
email
string
unique_external_id
string
payouts_aggregators
array of object (PayoutsAggregator)
Array of PayoutsAggregator
payout_details_id
integer
aggregator_id
integer
aggregator_fund_id
string
Nullable
success
boolean
Examples
Parameters
organization_id:
"1"
unique_transfer_no:
"1"
unique_external_id:
1
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
organization_id
unique_transfer_no
string
Required
unique_transfer_no
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
unique_transfer_no:
"1"
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
organization_id
unique_transfer_no
string
Required
unique_transfer_no
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
unique_transfer_no:
"1"
body:
body
Was this section helpful?
PATCH
Response
Parameters
organization_id
string
Required
organization_id
unique_transfer_no
string
Required
unique_transfer_no
Request body
unique_external_id
string
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Response
200
Success.
PostPayoutDetails
success
boolean
users
object (Users)
Users
name
string
email
string
unique_external_id
string
mobile
string
is_active
boolean
unique_transfer_no
string
aggregator
string
transfer_type
string
bank_details
object (BankDetails)
BankDetails
account_no
string
city
string
bank_name
string
account_type
string
state
string
account_holder
string
country
string
ifsc_code
string
branch_name
string
created
boolean
payouts
object (Payouts)
Payouts
aggregator_fund_id
string
Nullable
payment_status
string
updated
boolean
Examples
Parameters
organization_id:
"1"
unique_transfer_no:
"1"
body:
body
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
organization_id
unique_transfer_no
integer
Required
unique_transfer_no.
Response
200
Success Returns Payout details.
PayoutDetails
items
array of object (PayoutItem)
Array of PayoutItem
unique_transfer_no
string
more_attributes
object (MoreAttributes)
MoreAttributes
city
string
state
string
country
string
bank_name
string
ifsc_code
string
account_no
string
branch_name
string
account_type
string
account_holder
string
transfer_type
string
is_default
boolean
is_active
boolean
customers
object (Customers)
Customers
id
integer
name
string
mobile
string
email
string
unique_external_id
string
payouts_aggregators
array of object (PayoutsAggregator)
Array of PayoutsAggregator
payout_details_id
integer
aggregator_id
integer
aggregator_fund_id
string
Nullable
success
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response