API Documentation & SDKs
Subscriptions
Discounts
Licenses
Customers
Products
Payouts
Miscellaneous
List Payouts
Get a list of all payouts associated with your account.
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
x >= 0Page number default is 0
x >= 0Response
The total amount of the payout.
The unique identifier of the business associated with the payout.
The total value of chargebacks associated with the payout.
The timestamp when the payout was created, in UTC.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The fee charged for processing the payout.
The payment method used for the payout (e.g., bank transfer, card, etc.).
The unique identifier of the payout.
The total value of refunds associated with the payout.
not_initiated, in_progress, on_hold, failed, success The tax applied to the payout.
The timestamp when the payout was last updated, in UTC.
The name of the payout recipient or purpose.
The URL of the document associated with the payout.
Any additional remarks or notes associated with the payout.
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"
}
]
}