> ## Documentation Index > Fetch the complete documentation index at: https://paystack-sdk.efobi.dev/llms.txt > Use this file to discover all available pages before exploring further. # Transaction > Complete API reference for the Transaction module in the Paystack TypeScript SDK ## Overview The Transaction class provides methods for interacting with Paystack's Transaction API. This module allows you to initialize transactions, verify payments, list transactions, charge saved authorizations, and more. ## Methods ### initialize Initializes a transaction from your backend. ```typescript theme={null} async initialize(transaction: TxnInitializeInput): Promise ``` The transaction details to initialize. Amount to charge (in kobo for NGN, pesewas for GHS, cents for ZAR and USD) Customer's email address Currency in which amount should be charged (defaults to NGN) Unique transaction reference. Only alphanumeric characters allowed Fully qualified URL to redirect to when transaction is completed If transaction is to create a subscription, provide plan code here Number of invoices to raise during subscription Stringified JSON object of custom data An array of payment channels to control what channels you want to make available to the user. Available channels: card, bank, ussd, qr, mobile\_money, bank\_transfer, eft, apple\_pay The split code of the transaction split The code for the subaccount that owns the payment A flat fee to charge the subaccount for this transaction Who bears Paystack charges URL to redirect user to for payment Access code for the transaction Unique reference for this transaction **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.initialize({ amount: "20000", email: "customer@email.com", currency: "NGN", reference: "unique-reference-123", }); if (error) { console.error("Transaction initialization failed:", error); } else { console.log("Redirect user to:", data.authorization_url); } ``` *** ### verify Confirms the status of a transaction. ```typescript theme={null} async verify(reference: string): Promise ``` The transaction reference to verify Transaction ID Domain type Transaction status (success, failed, abandoned, etc.) Transaction reference Amount charged in kobo/cents Currency code Payment channel used Gateway response message Customer information object Authorization details (for card payments) Custom metadata passed during initialization Fees charged ISO datetime when payment was made ISO datetime when transaction was created **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.verify("reference-123"); if (error) { console.error("Verification failed:", error); } else if (data.status === "success") { console.log("Payment successful:", data); } ``` *** ### list Lists transactions carried out on your integration. ```typescript theme={null} async list(input: TxnListInput): Promise ``` Query parameters for listing transactions. Number of records to fetch per page (defaults to 50) Page number to retrieve (defaults to 1) Filter by customer ID Filter by terminal ID Filter by transaction status Start date for date range filter End date for date range filter (ISO datetime) Array of transaction objects Next page URL Previous page URL Records per page **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.list({ perPage: 100, page: 1, status: "success", }); if (error) { console.error("Failed to list transactions:", error); } else { console.log(`Found ${data.length} transactions`); } ``` *** ### getTransactionById Retrieves details of a transaction carried out on your integration. ```typescript theme={null} async getTransactionById(id: number): Promise ``` The ID of the transaction Complete transaction object with all details (same structure as verify response) **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.getTransactionById(12345); if (error) { console.error("Failed to fetch transaction:", error); } else { console.log("Transaction details:", data); } ``` *** ### chargeAuthorization Charges an authorization marked as reusable. ```typescript theme={null} async chargeAuthorization(input: TxnChargeInput): Promise ``` The charge details. Amount to charge in kobo/cents Customer's email address Valid authorization code to charge Unique transaction reference Currency in which amount should be charged Custom data object Payment channels to use (card or bank) Subaccount code Flat fee to charge the subaccount Who bears Paystack charges (defaults to account) Queue transaction (defaults to false) Amount charged Currency code ISO datetime of transaction Transaction status Transaction reference Authorization details Customer information Transaction ID **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.chargeAuthorization({ amount: 10000, email: "customer@email.com", authorization_code: "AUTH_code123", }); if (error) { console.error("Charge failed:", error); } else { console.log("Charge successful:", data.status); } ``` *** ### viewTxnTimeline Views the timeline of a transaction. ```typescript theme={null} async viewTxnTimeline(id_or_reference: string): Promise ``` The ID or reference of the transaction ISO time when transaction started Time spent in milliseconds Number of attempts Number of errors Whether transaction succeeded Whether transaction was from mobile Array of timeline events **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.viewTxnTimeline("reference-123"); if (error) { console.error("Failed to fetch timeline:", error); } else { console.log("Transaction timeline:", data.history); } ``` *** ### getTxnTotals Retrieves the total volume of transactions received on your integration. ```typescript theme={null} async getTxnTotals(input: GenericInput): Promise ``` Query parameters for transaction totals. Records per page Page number Start date (ISO datetime) End date (ISO datetime) Total number of transactions Total transaction volume Volume breakdown by currency Pending transfers count Pending transfers by currency **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.getTxnTotals({ perPage: 50, page: 1, }); if (error) { console.error("Failed to fetch totals:", error); } else { console.log(`Total transactions: ${data.total_transactions}`); } ``` *** ### exportTxns Exports a list of transactions carried out on your integration. ```typescript theme={null} async exportTxns(input: TxnExportInput): Promise ``` Query parameters for exporting transactions. Records per page Page number Start date (ISO datetime) End date (ISO datetime) Customer ID filter Transaction status filter Currency filter Amount filter Settlement status filter Settlement ID filter Payment page ID filter URL to download the export file ISO datetime when the export expires **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.exportTxns({ from: "2024-01-01T00:00:00Z", to: "2024-12-31T23:59:59Z", status: "success", }); if (error) { console.error("Export failed:", error); } else { console.log("Download export from:", data.path); } ``` *** ### partialDebit Retrieves part of a payment from a customer. ```typescript theme={null} async partialDebit(input: TxnPartialDebitInput): Promise ``` The partial debit details. Authorization code for the transaction Currency (defaults to NGN) Amount to debit Customer's email address Unique transaction reference Minimum amount to charge Amount charged Currency code Transaction status Transaction reference Originally requested amount **Example Usage:** ```typescript theme={null} const { data, error } = await paystack.transaction.partialDebit({ authorization_code: "AUTH_code123", currency: "NGN", amount: 50000, email: "customer@email.com", at_least: 30000, }); if (error) { console.error("Partial debit failed:", error); } else { console.log(`Charged ${data.amount} of ${data.requested_amount}`); } ``` *** ## Related Guides * [Getting Started](/quickstart) * [Transactions Guide](/guides/transactions) * [Webhooks Guide](/guides/webhooks)