# Pivot Docs ## Get Started - [Pivot Products Documentation and Guide](https://pivot-payment.gitbook.io/pivot-docs/pivot-products-documentation-and-guide.md): Pivot documentation helps you explore Payment Gateway, Local Payout, Wallet, Account and Balance Management—built to support your needs. - [Create your Pivot account](https://pivot-payment.gitbook.io/pivot-docs/quick-start/create-your-pivot-account.md): Learn how to onboard your business on Pivot - [First login and setup account](https://pivot-payment.gitbook.io/pivot-docs/quick-start/first-login-and-setup-account.md): Complete your account setup before taking your Pivot account live - [Invite team member](https://pivot-payment.gitbook.io/pivot-docs/quick-start/first-login-and-setup-account/invite-team-member.md): Invite team members with specific roles to handle various tasks within the dashboard - [Manage team member](https://pivot-payment.gitbook.io/pivot-docs/quick-start/first-login-and-setup-account/manage-team-member.md): Manage your team members' roles and permissions for efficient payment processing - [Manage account](https://pivot-payment.gitbook.io/pivot-docs/quick-start/first-login-and-setup-account/manage-account.md): Learn how to manage and secure your Pivot account - [Accept a Payment](https://pivot-payment.gitbook.io/pivot-docs/quick-start/accept-a-payment.md): Process your first transaction, and withdraw funds effortlessly - [Use Pivot without code](https://pivot-payment.gitbook.io/pivot-docs/quick-start/use-pivot-without-code.md): Simply use our dashboard to generate payment, send payouts, and monitor transactions in real-time. - [Business as Platform](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-platform.md) - [Accept Payment on behalf](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-platform/accept-payment-on-behalf.md): Onboard your Merchant as Sub-account, receive payment, and flexible to charge fee - [Send Payout on behalf](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-platform/send-payout-on-behalf.md): Onboard your Merchant as Sub-account, Send Payout, and flexible to charge fee - [Accept Payment and Split (Multi-Party)](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-platform/accept-payment-and-split-multi-party.md): Onboard your Partner as Sub-account, receive payment, and split to multiple party - [Business as Merchant](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-merchant.md) - [Accept Payment and Send Payout](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-merchant/accept-payment-and-send-payout.md): Start receiving funds from Payment and Send to Beneficiary account - [Accept Payment](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-merchant/accept-payment.md): Start receiving funds from your Customer - [Send Payout](https://pivot-payment.gitbook.io/pivot-docs/solutions/business-as-merchant/send-payout.md): Start sending funds to your Beneficiary account - [Side Menu](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu.md) - [Balance History](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/balance-history.md) - [Domestic Payout](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/domestic-payout.md) - [Wallet](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/wallet.md) - [International Payout](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/international-payout.md) - [Payment](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/payment.md) - [Merchant Platform](https://pivot-payment.gitbook.io/pivot-docs/dashboard/side-menu/merchant-platform.md) - [Top Bar](https://pivot-payment.gitbook.io/pivot-docs/dashboard/top-bar.md) - [Settings](https://pivot-payment.gitbook.io/pivot-docs/dashboard/top-bar/settings.md) - [Account](https://pivot-payment.gitbook.io/pivot-docs/dashboard/top-bar/account.md) - [API Integration](https://pivot-payment.gitbook.io/pivot-docs/for-developers/api-integration.md): Quick start guide for API Integration - [Webhook or Callbacks](https://pivot-payment.gitbook.io/pivot-docs/for-developers/webhook-or-callbacks.md) - [Third Party Integrations](https://pivot-payment.gitbook.io/pivot-docs/for-developers/third-party-integrations.md) - [Pivot Payment Gateway for WooCommerce](https://pivot-payment.gitbook.io/pivot-docs/for-developers/third-party-integrations/pivot-payment-gateway-for-woocommerce.md) ## Account and Balance Management - [Overview](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/overview.md): Onboard users on your platforms and start processing their payments, and manage their pay out - [Account management](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/account-management.md) - [KYC vs Non-KYC Account](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/kyc-vs-non-kyc-account.md) - [Transaction capability](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/transaction-capability.md) - [Funds flow](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/funds-flow.md) - [Integration checklist](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/integration-checklist.md): Quick Start Guide for Integration team - [FAQs](https://pivot-payment.gitbook.io/pivot-docs/account-and-balance-management/faqs.md) ## Payments - [Get Started](https://pivot-payment.gitbook.io/pivot-docs/payments/get-started.md) - [Add Payment Channels](https://pivot-payment.gitbook.io/pivot-docs/payments/add-payment-channels.md) - [Supported Payment Method](https://pivot-payment.gitbook.io/pivot-docs/payments/add-payment-channels/supported-payment-method.md) - [Check your available Payment Methods and Channels](https://pivot-payment.gitbook.io/pivot-docs/payments/add-payment-channels/check-your-available-payment-methods-and-channels.md) - [Add Payment Methods and Channels](https://pivot-payment.gitbook.io/pivot-docs/payments/add-payment-channels/add-payment-methods-and-channels.md) - [Accept Payment](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment.md) - [Build Redirect Payment Page](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-redirect-payment-page.md) - [Build Customized Payment Page](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-customized-payment-page.md) - [Build Card Payment Use Case](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case.md) - [Card Customized Payment Page (Encryption)](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/card-customized-payment-page-encryption.md) - [Accept Non 3DS & Foreign Card (AVS)](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/accept-non-3ds-and-foreign-card-avs.md) - [Pay and Save Card (Tokenization)](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/pay-and-save-card-tokenization.md) - [Authorize and Capture](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/authorize-and-capture.md) - [Subscription and Automated Billing (Recurring)](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/subscription-and-automated-billing-recurring.md) - [Authenticate using external 3DS MPI](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/authenticate-using-external-3ds-mpi.md) - [Network Token Authorization](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-card-payment-use-case/network-token-authorization.md) - [Build Static Payment](https://pivot-payment.gitbook.io/pivot-docs/payments/accept-payment/build-static-payment.md) - [After the Payment](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment.md) - [Payment Notify](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/payment-notify.md): Payment Notify enables your system to react to real-time payment events such as when a payment is being processed, successfully paid, or canceled. - [Redirect Page for fulfillment](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/redirect-page-for-fulfillment.md) - [Check Payment Status](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/check-payment-status.md) - [Chargebacks](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks.md) - [What is Chargeback](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks/what-is-chargeback.md) - [Chargeback Flow and Key Parties](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks/chargeback-flow-and-key-parties.md) - [Merchant Responsibility](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks/merchant-responsibility.md) - [Chargebacks Fee](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks/chargebacks-fee.md) - [Impact of Chargebacks](https://pivot-payment.gitbook.io/pivot-docs/payments/after-the-payment/chargebacks/impact-of-chargebacks.md) - [State and Status](https://pivot-payment.gitbook.io/pivot-docs/payments/state-and-status.md) - [Payment Channels](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels.md) - [Cards](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/cards.md) - [Payment Flow](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/cards/payment-flow.md) - [Available Card Network](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/cards/available-card-network.md) - [E-Wallet](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/e-wallet.md) - [Payment Flow](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/e-wallet/payment-flow.md) - [Available E-Wallet](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/e-wallet/available-e-wallet.md) - [Limitation](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/e-wallet/limitation.md) - [Virtual Account](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account.md) - [Payment Flow](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account/payment-flow.md) - [Available Virtual Account](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account/available-virtual-account.md) - [Feature](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account/feature.md) - [Payment Virtual Account capability](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account/payment-virtual-account-capability.md) - [Limitation](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/virtual-account/limitation.md) - [QRIS](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/qris.md) - [Payment Flow](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/qris/payment-flow.md) - [Available QRIS](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/qris/available-qris.md) - [Activation](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/qris/activation.md) - [Limitation](https://pivot-payment.gitbook.io/pivot-docs/payments/payment-channels/qris/limitation.md) ## Payouts - [Get Started](https://pivot-payment.gitbook.io/pivot-docs/payouts/get-started.md) - [Payout Coverage](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-coverage.md) - [Top Up Balance](https://pivot-payment.gitbook.io/pivot-docs/payouts/top-up-balance.md) - [Domestic Payout](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-products/domestic-payout.md): Choose between manual payouts via Dashboard or automated payouts via API—whichever fits your business workflow best - [Payout via Dashboard](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-products/domestic-payout/payout-via-dashboard.md) - [Payout via API](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-products/domestic-payout/payout-via-api.md) - [Domestic Payout](https://pivot-payment.gitbook.io/pivot-docs/payouts/after-the-payout/domestic-payout.md) - [Payout Wehook](https://pivot-payment.gitbook.io/pivot-docs/payouts/after-the-payout/domestic-payout/payout-wehook.md): Receive real-time updates on your payout status directly to your configured endpoint. Ideal for automating reconciliation, notifying users, or triggering follow-up actions - [Check Payout Status](https://pivot-payment.gitbook.io/pivot-docs/payouts/after-the-payout/domestic-payout/check-payout-status.md) - [Domestic Payout](https://pivot-payment.gitbook.io/pivot-docs/payouts/state-and-status/domestic-payout.md) - [Domestic Payout](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-capabilities/domestic-payout.md) - [Limit](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-capabilities/domestic-payout/limit.md) - [Processing Time](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-capabilities/domestic-payout/processing-time.md) - [Payout Identifier](https://pivot-payment.gitbook.io/pivot-docs/payouts/payout-capabilities/domestic-payout/payout-identifier.md) ## API References - [Pivot API Reference for Developers](https://pivot-payment.gitbook.io/pivot-docs/api-references/pivot-api-reference-for-developers.md): Complete reference documentation for the Pivot API, including endpoints' code snippets and examples. Test them on Postman and explore how it works. - [Environment](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/environment.md): Available Environment for Pivot's API Development - [Authentication](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/authentication.md) - [Idempotency](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/idempotency.md) - [Pagination](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/pagination.md) - [Response](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/response.md): Response Handling for Pivot's API - [Errors](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/errors.md): Handling errors in Pivot's API - [Callback](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-information/callback.md) - [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) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://pivot-payment.gitbook.io/pivot-docs/pivot-products-documentation-and-guide.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.