SaligPay Node SDK

Wallets

Copy page

Get Wallet Account

Retrieve wallet account details by ID:

Code
 
const wallet = await saligpay.wallets.get("wallet_abc123");

Get Wallet Balance

Retrieve the current balance of a wallet:

Code
 
const balance = await saligpay.wallets.getBalance("wallet_abc123");

Transfer from Wallet

Initiate a transfer from a wallet to a bank account:

Code
 
const transfer = await saligpay.wallets.transfer("wallet_abc123", {
    destination_account: {
        number: "0987654321",
        name: "Juan Dela Cruz",
        bic: "BNORPHMM",
    },
    amount: 50000,
    provider: "instapay",
    description: "Withdrawal to bank",
    reference_number: "WDR-001",
    purpose: "withdrawal",
});

List Wallet Transfers

Retrieve a list of transfers for a wallet:

Code
 
const transfers = await saligpay.wallets.listTransfers("wallet_abc123", {
    limit: 20,
    status: "succeeded",
});

Get Specific Transfer

Retrieve details of a specific transfer:

Code
 
const transfer = await saligpay.wallets.getTransfer(
    "wallet_abc123",
    "tr_xyz789"
);

Wallet Response Types

WalletAccountResult

Code
 
interface WalletAccountResult {
    id: string;
    type: string;
    attributes: {
        account_name: string;
        account_number: string;
        available_balance: number;
        pending_balance?: number;
        status: string;
        limits: {
            daily: { max_amount: number; remaining: number };
            monthly: { max_amount: number; remaining: number };
            per_transaction: { max_amount: number };
        };
        type: string;
        created_at: number;
        updated_at: number;
    };
}

WalletBalanceResult

Code
 
interface WalletBalanceResult {
    available: number;
    pending: number;
}

WalletTransferResult

Code
 
interface WalletTransferResult {
    id: string;
    source_account: Account;
    destination_account: Account;
    amount: number;
    fee: number;
    currency: string;
    provider: string;
    status: string;
    reference_number?: string;
    purpose?: string;
    description?: string;
    batch_transfer_id: string;
    created_at: string;
    updated_at: string;
}

CreateWalletTransferResponse

Code
 
interface CreateWalletTransferResponse {
    id: string;
    transfers: WalletTransferResult[];
}

Account Interface

Code
 
interface Account {
    number: string;
    name: string;
    bic?: string;
}

Transfer Status Values

Status	Description
pending	Transfer is queued for processing
processing	Transfer is being processed
succeeded	Transfer completed successfully
failed	Transfer failed
cancelled	Transfer was cancelled

Transfer Providers

Provider	Description
instapay	InstaPay real-time transfer
pesonet	PESONet batch transfer