API Documentation & SDKs
- Introduction
- Code Integration Tutorial
- SDKs - Node, Python, PHP, Go, Ruby, Java & Kotlin
- Payments Integration Guide
- Subscription Integration Guide
- Mobile Integration Guide
- On Demand Subscriptions
- Webhooks Details
- Managing Products Via API
- Metadata Guide
- Configuring Allowed Payment Methods
- MCP Server
- Technical - FAQs
Subscriptions
Discounts
Licenses
Customers
Products
Payouts
Miscellaneous
Payouts
List Payouts
Get a list of all payouts associated with your account.
GET
/
payouts
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
console.log(payoutListResponse.business_id);
}
}
main();
{
"items": [
{
"amount": 123,
"business_id": "<string>",
"chargebacks": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"fee": 123,
"name": "<string>",
"payment_method": "<string>",
"payout_document_url": "<string>",
"payout_id": "<string>",
"refunds": 123,
"remarks": "<string>",
"status": "not_initiated",
"tax": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page size default is 10 max is 100
Required range:
x >= 0
Page number default is 0
Required range:
x >= 0
Response
200 - application/json
Payouts List
The response is of type object
.
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
console.log(payoutListResponse.business_id);
}
}
main();
{
"items": [
{
"amount": 123,
"business_id": "<string>",
"chargebacks": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"fee": 123,
"name": "<string>",
"payment_method": "<string>",
"payout_document_url": "<string>",
"payout_id": "<string>",
"refunds": 123,
"remarks": "<string>",
"status": "not_initiated",
"tax": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}