> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists.md).

# API Lists

- [Core Resources](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/core-resources.md)
- [Balance](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/core-resources/balance.md): Retrieve your current available balance in real-time and access your balance history
- [Retrieve Balance](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/core-resources/balance/retrieve-balance.md): Get the latest available balance amounts for your account, allowing you to monitor funds in real-time
- [Retrieve Balance History](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/core-resources/balance/retrieve-balance-history.md): Access a record of past balance changes over time
- [Retrieve List of Sub-Merchants Balance](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/core-resources/balance/retrieve-list-of-sub-merchants-balance.md): Retrieve the current balance information for all sub-merchants under your main account
- [Account and Balance](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance.md)
- [Sub-account Management](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management.md): Manage multiple entities in Pivot and helps you maintain accountability for all transactions occurred in those sub-accounts
- [Activity on behalf-of Sub-account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/activity-on-behalf-of-sub-account.md): Perform actions or transactions as a sub-account using the main account’s credentials
- [Create a Sub-account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/create-a-sub-account.md): Create a new sub-account
- [Assign User to a Sub-account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/assign-user-to-a-sub-account.md): Add admin user to your sub-account
- [Resend Invitation](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/resend-invitation.md): Resend email invitation to users of sub-account
- [Update a Sub-account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/update-a-sub-account.md): Update a sub-account Information
- [Retrieve a Sub-account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/retrieve-a-sub-account.md): Get a sub-account detail information
- [List of Sub-accounts](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/list-of-sub-accounts.md): Get a Collection of Sub-accounts
- [Sub-account Activation Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/sub-account-activation-callback.md): Register your Sub-account Activation Callback URL and get Activation status
- [Sub-accounts Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/sub-accounts-object.md)
- [Status](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/status.md)
- [Industry and Code List](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/industry-and-code-list.md)
- [Top-Ups](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/top-ups.md): View available Virtual Account payment channels and your assigned VA numbers for adding funds
- [Get VA Payment Channel List](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/top-ups/get-va-payment-channel-list.md): Retrieve available Virtual Account payment channel to Top Up
- [Get VA for Top Up](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/top-ups/get-va-for-top-up.md): Retrieve selected Virtual Account number to Top Up
- [Top Up Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/top-ups/top-up-callback.md): Register your Top Up Callback URL and get Top Up notification from your Account or Sub-Account
- [Transfer](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/transfer.md): Move funds internally within your platform, such as between sub-accounts, enabling flexible fund management and allocation
- [Create a Transfer](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/transfer/create-a-transfer.md): Single - One way money movement between platform accounts
- [Retrieve a Transfer](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/transfer/retrieve-a-transfer.md): Get a transfer details
- [List of Transfer](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/transfer/list-of-transfer.md): Get a Collection of transfer details
- [Transfer Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/transfer/transfer-object.md)
- [Withdrawal](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/withdrawal.md)
- [Create a Withdrawal](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/withdrawal/create-a-withdrawal.md): Initiate a withdrawal either to your Payout Balance or directly to a Bank Account
- [Withdrawal Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/withdrawal/withdrawal-callback.md): Register your Withdrawal Callback URL and get Withdrawal notification from your Account or Sub-Account
- [Withdrawal Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/withdrawal/withdrawal-object.md): A withdrawal object is created when you initiate a withdrawal request.
- [Split Payment and Routing](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/split-payment-and-routing.md): Automatically divide a single payment and route funds to multiple accounts based on custom rules
- [Response Code](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/response-code.md)
- [Payments](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments.md)
- [Get Payment Method Config](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/get-payment-method-config.md): Retrieve enabled Payment Method configuration
- [Card Encryption](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/card-encryption.md)
- [Payment Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session.md)
- [Create Payment Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session/create-payment-session.md): Request a windowed time of payment session
- [Confirm Payment Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session/confirm-payment-session.md): Confirm your chosen Payment Method, applicable if "autoConfirm" is false
- [Retrieve Payment Session Details](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session/retrieve-payment-session-details.md): Get a detailed Payment Session by ID or Client Reference ID
- [Retrieve list of Payment Sessions](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session/retrieve-list-of-payment-sessions.md): Get all of your created Payment Sessions
- [Cancel Payment Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-session/cancel-payment-session.md): Void an unpaid payment session, preventing further transactions
- [Capture](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/capture.md): Capture your Card Payment method later, applicable if "captureMerhod" is MANUAL
- [Recurring](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/recurring.md)
- [Create Recurring](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/recurring/create-recurring.md): Configure plans, pricing, intervals, and trial settings
- [Cancel Recurring](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/recurring/cancel-recurring.md): Cancel recurring plans and end billing schedules
- [Retrieve Charge Details](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/retrieve-charge-details.md): Get a detailed Charge by Client Reference ID
- [Payment Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-callback.md): Register your Payment Callback URL and get Payment status
- [Payment Simulation](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/payment-simulation.md): Simulate payment flows without using real money
- [Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object.md)
- [Amount Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/amount-object.md)
- [Payment Method Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/payment-method-object.md)
- [Payment Method Options Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/payment-method-options-object.md)
- [Redirect Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/redirect-object.md)
- [Order Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/order-object.md)
- [Payment Session Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/payment-session-object.md)
- [Charge Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/charge-object.md)
- [Card Charge Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/charge-object/card-charge-object.md)
- [Virtual Account Charge Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/charge-object/virtual-account-charge-object.md)
- [QR Charge Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/charge-object/qr-charge-object.md)
- [Ewallet Charge Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/charge-object/ewallet-charge-object.md)
- [FDS Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/fds-object.md)
- [Installment Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/object/installment-object.md)
- [Response & Failure Code](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/response-and-failure-code.md)
- [Status](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payments/status.md)
- [Refunds](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds.md)
- [Create Refund](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/create-refund.md): Request a refund of your payment session
- [Retrieve Refund Details](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/retrieve-refund-details.md): Get a detailed Refund by ID
- [Retrieve list of Refund](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/retrieve-list-of-refund.md): Get all of your created Refun
- [Refund Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/refund-callback.md): Register your Refund Callback URL and get Refund status
- [Refund Simulation](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/refund-simulation.md): Simulate refund flows with various behaviors and conditions
- [Refund Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/refunds/refund-object.md): A refund object is created when you initiate a refund request.
- [Payout (Local)](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local.md)
- [⭐️ Local Payout API Integration Guide](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/local-payout-api-integration-guide.md): How to integrate Pivot Local Payout API
- [Payout Balance](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/payout-balance.md): Get Payout Balance information
- [Inquiry Account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/inquiry-account.md): Inquire Payout beneficiary account information
- [Retrieve Inquiry Account](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/retrieve-inquiry-account.md): Retrieve Inquiry Account results by Inquiry Account ID
- [Create a Payout](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/create-a-payout.md): Create payout transactions, supports capability for bulk payout or single payout.
- [Retrieve a single payout request](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/retrieve-a-single-payout-request.md): Retrieve payout by ID and reference Id
- [Retrieve a Payout](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/retrieve-a-payout.md): Retrieve Payout by ID
- [Payout Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/payout-callback.md): Register your Callback URL and get payout notification whenever Payout request status is DONE
- [Payout Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/payout-object.md): A payout object is created when you initiate a payout to a local bank account.
- [Response Codes & Failure Reason](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/response-codes-and-failure-reason.md)
- [Test Scenarios](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/test-scenarios.md)
- [Channel Codes](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/channel-codes.md)
- [Payout (International)](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international.md)
- [Get FX Rate](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/get-fx-rate.md)
- [Sender](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender.md)
- [Create Sender](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender/create-sender.md)
- [Update Sender](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender/update-sender.md)
- [Deactivate Sender](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender/deactivate-sender.md)
- [Get Sender by ID](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender/get-sender-by-id.md)
- [Get Sender List](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/sender/get-sender-list.md)
- [Beneficiary](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary.md)
- [Create Beneficiary](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/create-beneficiary.md)
- [Get Beneficiary by ID](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/get-beneficiary-by-id.md)
- [Get Beneficiary List](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/get-beneficiary-list.md)
- [Update Beneficiary](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/update-beneficiary.md)
- [Deactivate Beneficiary](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/deactivate-beneficiary.md)
- [Transaction](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction.md)
- [Create Transaction](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/create-transaction.md)
- [Create Payout Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/create-payout-session.md)
- [Upload Document](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/upload-document.md)
- [Confirm Payout Session](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/confirm-payout-session.md)
- [Payout Notification](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/payout-notification.md)
- [Get Payout List](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/get-payout-list.md)
- [Get Payout Detail](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/get-payout-detail.md)
- [Upload RFI](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/transaction/upload-rfi.md)
- [Retrieve Master Data](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/retrieve-master-data.md)
- [Object](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object.md)
- [FX](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/fx.md)
- [Sender](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/sender.md)
- [Beneficiary](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/beneficiary.md)
- [International Payout](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/international-payout.md)
- [List of Purpose Code](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/list-of-purpose-code.md)
- [Payout Status](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/payout-status.md)
- [Country Mapping](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/country-mapping.md)
- [RFI Entities](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/rfi-entities.md)
- [Service Capabilities](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/service-capabilities.md)