initialize_transaction
Create a new transaction with details like email, amount, currency, reference, callback URL, plan, invoice limit, and metadata.
EnabledExample request and response
{
"request": {
"email": "customer@example.com",
"amount": "10000",
"currency": "NGN",
"reference": "toolplane-payment-0001"
}
}verify_transaction
Check the status and validity of a transaction using its unique reference ID.
Enabledlist_transactions
Retrieve a paginated list of transactions filtered by date, customer, terminal ID, status, and amount.
Enabledfetch_transaction
Retrieve detailed information for a specific transaction using its unique ID.
Enabledcharge_authorization
Charge a payment using a reusable authorization with details like email, amount, currency, reference, and optional metadata and channels.
Enabledget_transaction_timeline
Retrieve the detailed timeline of a transaction using its ID or reference.
Enabledget_transaction_totals
Retrieve transaction totals with optional pagination and date range filters.
Enabledexport_transactions
Export transaction data with filters for date range, customer, status, currency, amount, and pagination options.
Enabledpartial_debit
Partially debit a transaction authorization using authorization code, amount, currency, email, reference, and minimum amount parameters.
Enabledcreate_charge
Create a payment charge with details like email, amount, currency, reference, metadata, device ID, split code, and subaccount.
Enabledsubmit_charge_pin
Submit a charge PIN using the provided reference and PIN to authorize the transaction.
Enabledsubmit_charge_otp
Submit a one-time password (OTP) to verify and complete a payment using the provided reference and OTP code.
Enabledsubmit_charge_phone
Submit a phone number with a reference to initiate a charge request.
Enabledsubmit_charge_birthday
Submit a charge request with a reference ID and the user's birthday date.
Enabledsubmit_charge_address
Submit billing address details including reference, address, city, state, and zipcode for charge processing.
Enabledcheck_pending_charge
Retrieve the status of a pending charge using its reference ID.
Enabledlist_bulk_charge_batches
Retrieve paginated bulk charge batches filtered by date range with optional page and per-page limits.
Enabledinitiate_bulk_charge
Start a bulk payment process by submitting a request to charge multiple accounts simultaneously.
Enabledfetch_bulk_charge_batch
Retrieve details of a bulk charge batch using its ID or code.
Enabledfetch_bulk_batch_charges
Retrieve charges from a batch using its ID or code, with optional filters for pagination, date range, and status.
Enabledpause_bulk_charge_batch
Pause a bulk charge batch using its batch code.
Enabledresume_bulk_charge_batch
Resume a paused bulk charge batch using the specified batch code.
Enabledlist_plans
Retrieve a paginated list of payment plans filtered by status, interval, and amount.
Enabledcreate_plan
Create a payment plan with details like name, amount, interval, description, currency, invoice limits, and options to send invoices or SMS.
Enabledfetch_plan
Retrieve detailed information about a payment plan using its ID or code.
Enabledupdate_plan
Update a payment plan's details including name, amount, interval, description, notifications, and currency by plan ID or code.
Enabledlist_subscriptions
Retrieve a paginated list of subscriptions, with optional filters for customer and plan details.
Enabledcreate_subscription
Create a subscription by providing customer details, plan, authorization, and start date.
Enabledfetch_subscription
Retrieve detailed subscription information using a subscription ID or code.
Enabledenable_subscription
Activate a subscription using a provided code and authentication token.
Enableddisable_subscription
Disable a subscription using the provided code and authentication token.
Enabledgenerate_subscription_update_link
Generate a secure link to update the subscription details using the provided subscription code.
Enabledsend_subscription_update_link
Send an email with a subscription update link using the provided subscription code.
Enabledlist_transaction_splits
Retrieve a paginated list of transaction splits with optional filters for date range, name, status, and sorting.
Enabledcreate_transaction_split
Create a transaction split with specified name, type, currency, subaccounts, and bearer details via a POST request.
Enabledfetch_transaction_split
Retrieve detailed information about a specific transaction split using its unique ID.
Enabledupdate_transaction_split
Update a transaction split by ID with new name, status, bearer type, and bearer subaccount details.
Enabledadd_or_update_split_subaccount
Add or update a subaccount's share in a revenue split by specifying the split ID, subaccount, and share amount.
Enabledremove_split_subaccount
Remove a specified subaccount from a split by its ID.
Enabledlist_subaccounts
Retrieve a paginated list of subaccounts with optional date range filters.
Enabledcreate_subaccount
Create a new subaccount with default settings via a POST request to the subaccount endpoint.
Enabledfetch_subaccount
Retrieve detailed information about a subaccount using its ID or code.
Enabledupdate_subaccount
Update a subaccount's details using its ID or code, including business name, bank info, contact details, and description.
Enabledlist_dedicated_accounts
Retrieve a list of dedicated virtual accounts filtered by status, currency, provider, bank, or customer.
Enabledcreate_dedicated_account
Create a dedicated virtual account with customer details, preferred bank, subaccount, split code, and contact information.
Enabledassign_dedicated_account
Assign a dedicated virtual account using user details including name, email, phone, bank info, account number, BVN, and bank code.
Enabledfetch_dedicated_account
Retrieve details of a specific dedicated virtual account using its unique ID.
Enableddeactivate_dedicated_account
Deactivate a dedicated virtual account by its unique ID.
Enabledrequery_dedicated_account
Retrieve transaction details for a dedicated account using account number, provider identifier, and date.
Enabledsplit_dedicated_account
Split a customer's dedicated account by subaccount, split code, and preferred bank via a POST request.
Enabledremove_dedicated_account_split
Delete the split configuration for a dedicated account using the account number.
Enabledlist_dedicated_account_providers
Retrieve a list of available providers offering dedicated accounts.
Enabledinitialize_preauthorization
Initialize a card preauthorization by providing payment details, customer email, amount, currency, reference, callback URL, metadata, and optional split info.
Enabledcapture_preauthorization
Capture a specified amount of preauthorized funds using reference and currency details.
Enabledreserve_preauthorization
Reserve funds on a reusable payment authorization using email, amount, authorization code, currency, and reference details.
Enabledverify_preauthorization
Check the status of a preauthorization using its reference ID.
Enabledrelease_preauthorization
Release preauthorized funds using a reference identifier to free reserved amounts.
Enabledlist_preauthorizations
Retrieve a paginated list of preauthorizations filtered by date, customer, status, and amount.
Enabledlist_apple_pay_domains
Retrieve a paginated list of registered Apple Pay domains with optional cursor-based navigation.
Enabledregister_apple_pay_domain
Register a domain for Apple Pay by submitting the domain name via a POST request.
Enabledunregister_apple_pay_domain
Remove a registered Apple Pay domain by specifying its domain name.
Enabledrequery_capitec_pay
POST request to requery the status of a payment charge using the provided reference ID.
Enabledlist_disputes
Retrieve a paginated list of disputes filtered by date range, transaction ID, and status.
Enabledfetch_dispute
Retrieve detailed information about a specific dispute using its unique ID.
Enabledupdate_dispute
Update a dispute by ID, modifying refund amount and uploaded file details.
Enabledlist_transaction_disputes
Retrieve a list of disputes associated with a specific transaction by its ID.
Enabledadd_dispute_evidence
Submit evidence for a dispute by providing customer info, service details, delivery address, and delivery date.
Enabledget_dispute_upload_url
Retrieve a secure upload URL to attach a file to a specific dispute using its ID and the upload filename.
Enabledresolve_dispute
Resolve a dispute by providing resolution details, message, refund amount, evidence, and optional uploaded file using the dispute ID.
Enabledexport_disputes
Retrieve a filtered list of disputes with pagination and export options based on date range, transaction ID, and status.
Enabledlist_refunds
Retrieve a paginated list of refunds filtered by date range, transaction ID, currency, or reference number.
Enabledcreate_refund
Initiate a refund by specifying transaction details, amount, currency, and optional customer and merchant notes with a reference.
Enabledretry_refund_with_customer_details
Retry a refund by submitting customer bank details using the refund ID and account information.
Enabledfetch_refund
Retrieve detailed information about a specific refund using its unique ID.
Enabledlist_customers
Retrieve a paginated list of customers with optional date range filters for precise results.
Enabledcreate_customer
Create a new customer with email, first name, last name, phone, and optional metadata details.
Enabledfetch_customer
Retrieve customer details using their email or unique code identifier.
Enabledupdate_customer
Update a customer's details using their identifier, including first name, last name, phone, and additional metadata.
Enabledvalidate_customer
Verify a customer's identity using personal details and banking information for accurate validation.
Enabledset_customer_risk_action
Assign a specific risk action to a customer by providing their identifier and the desired risk action.
Enabledinitialize_customer_authorization
Initialize reusable direct-debit authorization by providing customer email, channel, callback URL, account, and address details.
Enabledverify_customer_authorization
Check if a customer authorization request identified by a reference is valid and approved.
Enabledinitialize_customer_direct_debit
Set up direct debit for a customer using their ID, bank account, and address details.
Enabledactivate_customer_direct_debit
Activate a customer's direct debit mandate by triggering the associated activation charge using customer and authorization IDs.
Enabledfetch_customer_mandates
Retrieve direct debit mandate authorizations for a specific customer by their ID.
Enableddeactivate_customer_authorization
Deactivate a customer's authorization using the provided authorization code.
Enabledtrigger_mandate_activation_charges
Activate pending direct debit mandate charges for specified customers by providing their IDs.
Enabledlist_mandate_authorizations
Retrieve a paginated list of mandate authorizations filtered by status, with optional cursor-based navigation.
Enabledlist_payment_banks
Retrieve a list of payment banks and providers filtered by country, currency, type, and pagination options.
Enabledlist_address_verification_states
Retrieve a list of address verification states for a specified country.
Enabled