SaligPay Node SDK

Payouts

Copy page

List Payouts

Retrieve a list of payouts with optional filtering and pagination:

Code
 
const payouts = await saligpay.payouts.list({
    payout_status: "deposited",
    sort_by: "created_at",
    order: "desc",
    limit: 20,
});

List Options

Parameter	Type	Description
search	string	Search by payout ID or merchant ID
payout_status	string	pending, on_hold, in_transit, deposited, returned, cancelled
sort_by	string	created_at or net_amount
order	string	asc or desc
provider	string	paymongo_central_hub or unionbank
created_at.between	string	Date range: YYYY-MM-DD..YYYY-MM-DD
limit	number	1-100, default 10
after	string	Pagination cursor
before	string	Pagination cursor

Get Payout Details

Retrieve details for a specific payout by ID:

Code
 
const payout = await saligpay.payouts.get("po_abc123");

Get Payout Transactions

Retrieve the transactions associated with a payout:

Code
 
const transactions = await saligpay.payouts.getTransactions("po_abc123", {
    limit: 10,
});

Get Payout Schedule

Retrieve the payout schedule for an organization:

Code
 
const schedule = await saligpay.payouts.getSchedule("org_merchant123");

Payout Response Types

PayoutListResult

Code
 
interface PayoutListResult {
    total_amount: number;
    total_per_currency: Record<string, { total_amount: number }>;
    total_records: number;
    pagination: { next_cursor: string | null; prev_cursor: string | null };
    data: Array<{ id: string; type: string; attributes: PayoutAttributes }>;
}

PayoutDetailResult

Code
 
interface PayoutDetailResult {
    id: string;
    type: string;
    attributes: PayoutAttributes;
}

PayoutAttributes

Code
 
interface PayoutAttributes {
    amount: number;
    adjustment_amount: number;
    bank_account_name: string;
    bank_account_number: string;
    bank_name: string;
    converted_net_amount: number;
    currency: string;
    currency_exchange_rate: CurrencyExchangeRate;
    description: string;
    digital_tax: number;
    digital_withholding_vat_amount: number;
    dispute_amount: number;
    fee: number;
    foreign_fee: number;
    last_payout_transfer: LastPayoutTransfer | null;
    net_amount: number;
    organization: Organization;
    provider: string;
    refund_amount: number;
    status: string;
    tax_amount: number;
    taxes: Tax[];
    created_at: number;
    status_updated_at: number;
    updated_at: number;
}

Status Values

Status	Description
pending	Payout is queued for processing
on_hold	Payout is temporarily held
in_transit	Payout is being transferred to the bank
deposited	Funds have been deposited to the bank account
returned	Payout was returned by the bank
cancelled	Payout was cancelled before processing