# Localpayment Documentation > Simplify global payments with Localpayment's easy-to-use APIs. Our detailed documentation and developer support make integration a breeze. ## Guides: INTRODUCTION - [Get started](https://docs.localpayment.com/docs/get-started.md): Unlocking the economic potential of emerging markets. Localpayment delivers the payment platform to securely scale your business across Latin America and beyond. - [Onboarding Process](https://docs.localpayment.com/docs/onboarding-process.md): Get started with payment processing by completing our merchant onboarding, including document submission and account verification. - Initial Setup - [Setup Guide](https://docs.localpayment.com/docs/setup-guide.md): Review the complete list of requirements you need to get your Localpayment integration fully set up after your onboarding is approved. - [API Keys & Environments](https://docs.localpayment.com/docs/api-keys-and-environments.md): Learn how to manage your API credentials and environment configurations so you can integrate with Localpayment securely and confidently. - [Authentication](https://docs.localpayment.com/docs/authentication.md): We use OAuth 2.0 for API authentication. Learn how you can generate and use access tokens securely by following our best practices. - Build with AI - [AI Overview](https://docs.localpayment.com/docs/ai-overview.md): Explore the AI tools available in Localpayment's developer portal. Connect your AI-powered editor, feed your LLM with clean documentation, and deploy a specialist integration agent — all without… - [MCP Server](https://docs.localpayment.com/docs/mcp-server.md): Connect your AI-powered workflow to Localpayment's live API spec and documentation using the Model Context Protocol (MCP). Setup instructions for Cursor, VS Code, Claude, Windsurf, ChatGPT, Gemini… - [Prompt Library](https://docs.localpayment.com/docs/prompt-library.md): A curated collection of ready-to-use prompts for building, debugging, and testing Localpayment integrations. Organized by use case and country. Copy, paste, and accelerate. - [Plain Text Docs & LLMs.txt](https://docs.localpayment.com/docs/llms-txt.md): Feed any LLM with clean, token-efficient versions of Localpayment's documentation. Use the llms.txt index for a structured overview, or add .md to any documentation URL for article-level Markdown… - [AI Agents](https://docs.localpayment.com/docs/ai-agents.md): A library of specialist AI agents for Localpayment integrations. Deploy the Integrator Agent to build faster, or the QA Agent to validate your integration. Compatible with OpenAI Agents SDK,… - [AI Security & Best Practices](https://docs.localpayment.com/docs/ai-security.md): Security guidelines for developers using AI tools to build Localpayment integrations. Protect your credentials, handle payment data responsibly, and review AI-generated code before deploying to… - [User Roles & Permissions](https://docs.localpayment.com/docs/user-roles-and-permissions.md): How to structure access to the Localpayment Business Portal and APIs. Built-in roles, custom roles, and a recommended least-privilege model for payments operations. - [Make your first test payment](https://docs.localpayment.com/docs/make-your-first-test-payment.md): Learn how you can make your first test payment using the Localpayment API and understand the essentials for running secure payment flows in your sandbox environment. - [Webhooks](https://docs.localpayment.com/docs/webhooks.md): Learn how to use Localpayment webhooks so you can receive real-time notifications for every payment event. This guide helps you validate signatures, process webhook data, and keep your integration in… - [Error Handling](https://docs.localpayment.com/docs/error-handling.md): Effective error handling is crucial for building robust integrations with the Localpayment API. Understanding the different error types and their corresponding codes will help you diagnose issues… - [Testing](https://docs.localpayment.com/docs/testing.md): Complete guide to testing integration. Test data, scenarios, and validation checklist. - [System Status & Incident Updates](https://docs.localpayment.com/docs/system-status-incident-updates.md): Stay informed about the operational status of Localpayment's APIs and services. Our real-time status business portal is your official source for service health, incident updates, and maintenance… - [Glossary](https://docs.localpayment.com/docs/glossary.md): Explore the Localpayment API glossary to understand key payment, transaction, and integration terms for building reliable solutions. - [FAQ](https://docs.localpayment.com/docs/faq.md): Find answers to your most common questions about payments, API integration, and Localpayment services—helping you troubleshoot faster and stay informed. ## Guides: COUNTRIES & MARKETS - [Global Coverage](https://docs.localpayment.com/docs/global-coverage.md): Our payment infrastructure spans across **Latin America**, supporting multiple payment methods, currencies, and local preferences in each market. This comprehensive coverage enables seamless… - Countries - [Argentina](https://docs.localpayment.com/docs/argentina.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Argentina** with Localpayment. This guide provides a comprehensive overview of everything… - [Bolivia](https://docs.localpayment.com/docs/bolivia.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Bolivia** with Localpayment. This guide provides a comprehensive overview of everything… - [Brazil](https://docs.localpayment.com/docs/brazil.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Brazil** with Localpayment. This guide provides a comprehensive overview of everything you… - [Chile](https://docs.localpayment.com/docs/chile.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Chile** with Localpayment. This guide provides a comprehensive overview of everything… - [Colombia](https://docs.localpayment.com/docs/colombia.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Colombia** with Localpayment. This guide provides a comprehensive overview of everything… - [Costa Rica](https://docs.localpayment.com/docs/costa-rica.md): Currency, payment methods, processing times, and other details for operating in Costa Rica with Localpayment. - [Dominican Republic](https://docs.localpayment.com/docs/dominican-republic.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Dominican Republic** with Localpayment. This guide provides a comprehensive overview of… - [El Salvador](https://docs.localpayment.com/docs/el-salvador.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **El Salvador** with Localpayment. This guide provides a comprehensive overview of… - [Guatemala](https://docs.localpayment.com/docs/guatemala.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Guatemala** with Localpayment. This guide provides a comprehensive overview of everything… - [Honduras](https://docs.localpayment.com/docs/honduras.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Honduras** with Localpayment. This guide provides a comprehensive overview of everything… - [Mexico](https://docs.localpayment.com/docs/mexico.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Mexico** with Localpayment. This guide provides a comprehensive overview of everything you… - [Panama](https://docs.localpayment.com/docs/panama.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Panama** with Localpayment. This guide provides a comprehensive overview of everything you… - [Paraguay](https://docs.localpayment.com/docs/paraguay.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Paraguay** with Localpayment. This guide provides a comprehensive overview of everything… - [Peru ](https://docs.localpayment.com/docs/peru.md): Learn more about currency, payment methods, processing times, and other essential details for operating in **Peru** with Localpayment. This guide provides a comprehensive overview of everything you… ## Guides: PAYINS - [Payins Overview](https://docs.localpayment.com/docs/payins-overview.md): Accept global payments seamlessly with a Payins solution. Drive higher conversion rates by processing one-time purchases & recurring subscriptions while complying with local regulations and preferred… - Card - [Card Overview](https://docs.localpayment.com/docs/card-overview.md): Localpayment facilitates seamless and secure card payments, enabling you to accept a wide range of credit and debit cards from your customers across diverse markets. - [Card Payment Method Codes](https://docs.localpayment.com/docs/card-payment-methods.md): Reference of paymentMethod codes for credit and debit cards by country, card brand, and currency. - [One-Time Payments](https://docs.localpayment.com/docs/one-time-payments.md): ​Localpayment enables merchants to process one-time payments using credit and debit cards, across multiple countries and currencies. - [Tokenization](https://docs.localpayment.com/docs/tokenization.md): Tokenization with Localpayment provides a secure way to handle card information, reducing your security risk and simplifying future transactions. - [Pre-Authorization & Capture](https://docs.localpayment.com/docs/pre-authorization-and-capture.md): A pre-authorization is a two-step process that allows merchants to verify a customer's payment method before completing a transaction. This process temporarily holds the transaction amount in the… - [3D Secure](https://docs.localpayment.com/docs/3d-secure.md): Enhance your online payment security with 3D Secure, the standard authentication protocol. Reduce unauthorized transactions with an extra verification layer, protecting your business and customers… - [Installments](https://docs.localpayment.com/docs/installments.md): Attract more customers by allowing them to split purchases into monthly payments. Learn how to easily implement and manage installment plans to boost conversion and average order value. - Virtual Accounts - [Virtual Accounts Overview](https://docs.localpayment.com/docs/virtual-accounts-overview.md): Unique, system-generated virtual accounts that automate payment reconciliation, enhance security, and organize customer transactions. - [Create a Virtual Account](https://docs.localpayment.com/docs/create-a-virtual-account.md): Generate virtual accounts for customers via Localpayment's API. Support for individual and batch processing. - [Simulate a Virtual Account Payment](https://docs.localpayment.com/docs/simulate-virtual-account-payment.md): Learn how to test your virtual account integration by simulating incoming payments in the Stage environment. Validate your webhook listeners and reconciliation logic without real bank transfers. - [Offline Virtual Account Creation](https://docs.localpayment.com/docs/offline-virtual-account-creation.md): Request virtual accounts manually through the Localpayment Support team for manual intervention, testing, or unavailable API integration. - [Get Virtual Account Status](https://docs.localpayment.com/docs/get-virtual-account-status.md): This guide outlines the different approaches for tracking virtual account status and managing account lifecycle. - [Payment Instructions](https://docs.localpayment.com/docs/payment-instructions.md): Use the beneficiary details returned in the API response to complete virtual account payments for each supported country. - [Enable/Disable Virtual Account](https://docs.localpayment.com/docs/activate-deactivate-virtual-account.md): Localpayment allows you to temporarily suspend or reactivate virtual accounts, providing flexibility to manage account status without permanent deletion. This is useful for temporary holds, dispute… - [Delete Virtual Account](https://docs.localpayment.com/docs/delete-virtual-account.md): Permanently disable virtual accounts that are no longer needed using the API endpoint. - [Receive Payment Notifications](https://docs.localpayment.com/docs/receive-payment-notifications.md): Receive instant webhook notifications for every Virtual Account payment, and update your systems and confirm credits automatically. - [Manage Virtual Account Aliases](https://docs.localpayment.com/docs/manage-virtual-account-aliases.md): Localpayment allows you to create and manage aliases for virtual accounts in Argentina, providing memorable references that can be used instead of CVU numbers for payments. - APMs - [APMs Overview](https://docs.localpayment.com/docs/apms-overview.md): Implement local payment rails like bank transfers & QR schemes. Our guide covers asynchronous payment flows, customer redirects, and receiving final payment status via webhook notifications. - [Virtual Account with Payment Intent - Argentina](https://docs.localpayment.com/docs/virtual-account-payment-intent-argentina.md): Assign a CVU per transaction for Argentina. Payment confirms only when the payer transfers the exact amount before the expiration window. - [QR (Argentina) ](https://docs.localpayment.com/docs/qr-argentina.md): Localpayment enables merchants to process instant payments through Argentina's standardized QR payment system. This guide outlines the process for initiating QR-based payments through Localpayment's… - [Debin (Argentina) ](https://docs.localpayment.com/docs/debin-argentina.md): Localpayment enables merchants to process instant bank transfers through Argentina's Debin (Débito Inmediato) system. This guide outlines the process for initiating Debin payments through… - [QR (Bolivia) ](https://docs.localpayment.com/docs/qr-bolivia.md): Localpayment enables merchants to process instant payments through Bolivia's interoperable QR payment system. This guide outlines the process for initiating QR-based payments through Localpayment's… - [Pix (Brazil)](https://docs.localpayment.com/docs/pix-brazil.md): Localpayment enables merchants to process instant payments through Brazil's Pix system, the country's revolutionary instant payment platform developed by the Central Bank of Brazil. This guide… - [ETPAY (Chile)](https://docs.localpayment.com/docs/etpay-chile.md): Localpayment enables merchants to process secure bank transfer payments through ETPAY, Chile's leading payment gateway that facilitates direct bank transfers and authentication with major Chilean… - [PSE (Colombia)](https://docs.localpayment.com/docs/pse-colombia.md): Localpayment enables merchants to process secure online payments through PSE (Pagos Seguros en Línea), Colombia's official online banking payment system developed by ACH (Automated Clearing House)… - [Bre-B (Colombia)](https://docs.localpayment.com/docs/bre-b-colombia.md): Bre-B is Colombia's national real-time payment rail, operated by Banco de la República. Accept instant A2A payments 24/7 via Virtual Account keys (payin) and send funds directly to any Bre-B key… - [QR Fri (Guatemala) ](https://docs.localpayment.com/docs/qr-fri-guatemala.md): Localpayment enables merchants to process instant payments through Guatemala's QR Fri payment system, the country's standardized interoperable QR payment platform regulated by the Bank of Guatemala. - [Wallet Fri (Guatemala) ](https://docs.localpayment.com/docs/wallet-fri-guatemala.md): Localpayment enables merchants to process instant digital wallet payments through Guatemala's Wallet Fri system. This guide outlines the process for initiating Wallet Fri payments through… - Subscriptions - [Subscriptions Overview ](https://docs.localpayment.com/docs/subscriptions-overview.md): Localpayment provides powerful subscription billing capabilities, enabling you to set up recurring payments for both fixed plans and custom billing scenarios. This section offers a comprehensive… - [Create a Subscription](https://docs.localpayment.com/docs/create-a-subscription.md): Localpayment enables merchants to set up recurring payment subscriptions using credit and debit cards, supporting both fixed plans and custom billing scenarios across multiple countries. This guide… - [Update a Subscription](https://docs.localpayment.com/docs/update-a-subscription.md): Localpayment enables you to modify existing subscriptions to accommodate changes in customer needs, such as upgrading or downgrading plans, updating billing information, or changing subscription… - [Cancel a Subscription](https://docs.localpayment.com/docs/cancel-a-subscription.md): Localpayment allows you to cancel active subscriptions when customers no longer wish to continue their recurring payments. This guide details the process for canceling a subscription through… - [Create a Subscription Plan](https://docs.localpayment.com/docs/create-a-subscription-plan.md): Localpayment enables you to create fixed subscription plans for standardized recurring billing scenarios. This guide details how to set up subscription plans through Localpayment's API, which can… - [Update a Subscription Plan](https://docs.localpayment.com/docs/update-a-subscription-plan.md): Localpayment allows you to modify existing subscription plans to accommodate changes in your pricing strategy, billing cycles, or service offerings. This guide details how to update a subscription… - [Get Subscription Plan](https://docs.localpayment.com/docs/get-subscription-plan.md): Localpayment provides an endpoint to retrieve detailed information about existing subscription plans. This guide explains how to fetch subscription plan details through Localpayment's API, allowing… - Payins Operations - Refunds Processing - [Refund a Card Payment](https://docs.localpayment.com/docs/refund-card-payment.md): Localpayment enables you to process refunds for card payments, allowing you to return funds to customers' credit or debit cards through both API integration and the Business Portal interface. This… - [Refund a Virtual Account Payment](https://docs.localpayment.com/docs/refund-virtual-account-payment.md): Localpayment enables you to process refunds for virtual account payments, allowing you to return funds to customers through both API integration and the Business Portal interface. This guide covers… - [Refund an APM Payment](https://docs.localpayment.com/docs/refund-apm-payment.md): Localpayment enables you to process refunds for Alternative Payment Methods (APMs) through both API integration and the Business Portal interface. This guide covers the complete refund workflow for… - [Download Refund Proof of Payment (POP)](https://docs.localpayment.com/docs/download-refund-proof-of-payment.md): Programmatically download the Proof of Payment (POP) document for completed Refund transactions. - [Chargeback Management](https://docs.localpayment.com/docs/chargebacks.md): Localpayment enables you to manage chargebacks through the Merchant Business Portal interface. This guide covers the complete chargeback management workflow, from understanding what chargebacks are… - Cancel - [Cancel an APM Payment](https://docs.localpayment.com/docs/cancel-apm-payment.md): Localpayment enables you to cancel pending APM payments through API integration. This guide covers the complete cancellation workflow for APM transactions using the direct cancellation method that… - [Wire Out](https://docs.localpayment.com/docs/wire-out.md): Localpayment enables you to withdraw funds from your Localpayment account and deposit them into your own external bank account through both API integration and the Business Portal interface. This… ## Guides: PAYOUTS - [Payouts Overview](https://docs.localpayment.com/docs/payouts-overview.md): Learn how Localpayment Payouts enable businesses to send payments across countries. - Bank Transfer - [Bank Transfer Overview](https://docs.localpayment.com/docs/bank-transfer-overview.md): Set up and manage bank transfer payouts through Localpayment. Efficiently send payments from your account directly to your recipients' bank accounts globally. - [Send funds via Bank Transfer](https://docs.localpayment.com/docs/send-funds-via-bank-transfer.md): Send funds via bank transfer using Localpayment's API. This guide covers everything you need to know about creating payouts, handling responses, managing transaction status, and meeting… - [Verify a Payout Alias](https://docs.localpayment.com/docs/verify-a-payout-alias.md): Check whether a payout alias is active and see the masked owner details before sending a payout. Currently available for Colombia only. - [Sandbox Testing for Payouts](https://docs.localpayment.com/docs/sandbox-testing-payouts.md): Use Stage test accounts to trigger specific payout rejection scenarios before going live with Bank Transfer payouts. - Wallet - [Wallets Overview](https://docs.localpayment.com/docs/wallets-overview.md): Send instant, secure payments directly to your recipients' digital wallets. Simplify your payout process and reduce costs. - [Send funds via Wallet](https://docs.localpayment.com/docs/send-funds-via-wallets.md): Send funds via Wallet using Localpayment's API. This guide covers everything you need to know about creating payouts, handling responses, managing transaction status, and meeting country-specific… - [Approvals & Double Signature](https://docs.localpayment.com/docs/approvals-and-double-signature.md): Some payout transactions require additional authorization before they can be processed. This guide explains when authorization is needed and how to approve payouts through different methods. - Payouts Operations - Wire In - [Wire In Overview](https://docs.localpayment.com/docs/wire-in-overview.md): Learn how to fund your Localpayment account via Wire In transfers from external financial institution. - [Incoming Wire In Notification ](https://docs.localpayment.com/docs/incoming-wire-in-notification.md): Notify Localpayment of an incoming wire transfer using our API to settle your account balance. This guide walks you through initiating a notification, handling API responses, and tracking the… - [Returns & Recalls](https://docs.localpayment.com/docs/returns-and-recalls.md): Learn the key differences between Recalls and Returns, when each applies, and how to manage them effectively in your payout flow. - [Cancel a payout](https://docs.localpayment.com/docs/cancel-a-payout.md): Sometimes you need to stop a payout after initiation, this guide covers cancellation procedures. - [Low Balance Alerts ](https://docs.localpayment.com/docs/low-balance-alerts.md): Prevent overdrafts and manage your finances proactively. Learn how these automated notifications help you avoid fees and maintain account health. - [Download Payout Proof of Payment (POP)](https://docs.localpayment.com/docs/download-proof-of-payment.md): Programmatically download the Proof of Payment (POP) document for completed Payout transactions. ## Guides: TAX, BILL, AND SERVICE PAYMENTS - [Tax, Bill and Service Payments Overview](https://docs.localpayment.com/docs/bill-pay-overview.md): Disburse statutory tax, bill, and service payments in Mexico. This overview covers scope, the payment flow, and transaction states. - [Send a Tax, Bill, or Service Payment](https://docs.localpayment.com/docs/send-a-bill-payment.md): Create a tax, bill, or service payment payout in Mexico, with request/response examples, error handling, and webhooks. ## Guides: TREASURY & FX - [Treasury Overview ](https://docs.localpayment.com/docs/treasury-overview.md): Treasury services provide comprehensive financial management solutions that help businesses efficiently manage their funds, execute currency conversions, and handle both domestic and international… - FX Services - [FX Overview](https://docs.localpayment.com/docs/fx-overview.md): Transfer money internationally and convert currencies between accounts seamlessly. Securely manage cross-border payments and exchange rates in one place. - [Quote Currency Conversion](https://docs.localpayment.com/docs/quote-currency-conversion.md): Get real-time currency exchange quotes with secure token-based rates for your international transactions. - [Bulk Currency Conversion](https://docs.localpayment.com/docs/bulk-currency-conversion.md): The Bulk Currency Conversion API enables you to perform individual or multiple Foreign Exchange (FX) transactions programmatically with optimal rates and processing efficiency. - [Lock an Exchange Rate ](https://docs.localpayment.com/docs/lock-an-exchange-rate.md): Locking an exchange rate lets you guarantee the conversion price before executing a transaction protecting you and your users from market fluctuations between quote and execution. - Transfers - [Internal Domestic Transfer](https://docs.localpayment.com/docs/internal-domestic-transfer.md): Secure internal transfers between your Localpayment accounts. Maintain liquidity and manage funds domestically without currency conversion. - [Internal Foreign Transfer](https://docs.localpayment.com/docs/internal-foreign-transfer.md): An internal foreign transfer enables you to securely transfer funds between your Localpayment accounts across different countries while preserving the same currency. - [Global Treasury Account](https://docs.localpayment.com/docs/global-treasury-account.md): Fund one USD Global Treasury Account and use its balance to pay out in several countries, with a daily auto-sweeping cycle. - [Reporting & Reconciliation](https://docs.localpayment.com/docs/reporting-and-reconciliation.md): Monitor your account activity, track balances, and reconcile transactions with Localpayment's comprehensive reporting tools. Access real-time insights through both our business portal interface and… ## Guides: CHECKOUT SOLUTIONS - [Checkout Solutions Overview](https://docs.localpayment.com/docs/checkout-solutions-overview.md): Choose the right checkout solution for your business needs. Our alternative payment solutions offer flexible integration options to traditional payins, each designed for different use cases and… - [WebCheckout](https://docs.localpayment.com/docs/webcheckout.md): WebCheckout is a powerful feature that allows you to generate and manage payment requests directly from your Business Portal. This streamlined solution provides a secure, user-friendly interface for… - [Payment Links](https://docs.localpayment.com/docs/payment-links.md): Generate shareable Payment Links to request payments. Send the secure URL to customers via SMS or email for a fast, hosted checkout without any complex integration needed. - [Embedded Iframe](https://docs.localpayment.com/docs/embedded-iframe.md): Seamlessly integrate a white-labeled checkout into your website. The Embedded iFrame delivers Localpayment's secure payment processing while preserving your brand identity. - Smart Fields - [Smart Fields Overview](https://docs.localpayment.com/docs/smart-fields-overview.md): Embed secure payment fields directly into your checkout. We host the data to simplify compliance and protect your brand, while you control the customer experience. - [Smart Fields Integration Guide](https://docs.localpayment.com/docs/smart-fields-integration-guide.md): This guide provides a detailed, step-by-step process for integrating Smart Fields into your payment checkout. By the end, you will be able to securely collect payment details directly within your… - [Smart Fields Testing & Demos](https://docs.localpayment.com/docs/smart-fields-testing-and-demos.md): Test Smart Fields safely in the Localpayment Sandbox. Simulate payments and validate your integration before going live. ## Guides: BUSINESS PORTAL GUIDE - [Business Portal Overview](https://docs.localpayment.com/docs/dashboard-overview.md): Sign in to the Localpayment Merchant Business Portal and learn how to navigate its main sections to manage your payment operations. - Reports - [Balance Report](https://docs.localpayment.com/docs/balance-report.md): Learn how to access and use the Balance report in Localpayment Business Portal to view your account balance and completed transactions with detailed filtering and export options. - [Projected Balance Report](https://docs.localpayment.com/docs/projected-balance-report.md): Learn how to access and use the Projected Balance report in Localpayment Business Portal to view your projected account balance and transactions with detailed filtering and export options. - [Activity Report](https://docs.localpayment.com/docs/activity-report.md): This report provides a comprehensive log of all sent transactions and their respective statuses. Please note that it does not display balance information. Its purpose is to enable a full review of… - [Transaction Detail Report](https://docs.localpayment.com/docs/transaction-detail-report.md): This report delivers a detailed breakdown of payment transactions and the associated parties, such as the payer and beneficiary. - [FIDES Report](https://docs.localpayment.com/docs/fides-report.md): The FIDES report is a daily ledger of completed transactions. It lists transactions with dates, IDs, debits/credits, and the resulting running balance. On inactive days, it reports only the opening… - [Historical Reports](https://docs.localpayment.com/docs/historical-reports.md): Track the status of your report exports and download them, including manual requests that exceeded 15,000 records and scheduled automatic reports. - Payins - Virtual Accounts - [View Virtual Accounts Activity](https://docs.localpayment.com/docs/dashboard-view-virtual-accounts-activity.md): Access your virtual account details and filter the list by country, processing status, or date to efficiently monitor and review specific accounts. - Refunds - [Create manual refund](https://docs.localpayment.com/docs/dashboard-create-manual-refund.md): Learn how to request manual refunds for your payin transactions through the Localpayment business portal with step-by-step instructions. - [Review a refund](https://docs.localpayment.com/docs/dashboard-review-a-refund.md): Maintain full control over your refunds. Efficiently monitor, approve, or cancel pending refunds from the centralized Localpayment Business Portal. - [Activity report](https://docs.localpayment.com/docs/dashboard-refunds-activity-report.md): Track and manage your refunds. Filter the list by country, processing status, or date to quickly find and review specific transaction details. - [Proof Of Payment](https://docs.localpayment.com/docs/dashboard-refunds-proof-of-payment.md): Access and download your official Proof of Payment vouchers directly from the Localpayment Business Portal. Your confirmation for completed payin refund transactions. - [Chargeback](https://docs.localpayment.com/docs/dashboard-chargeback.md): Track and respond to chargebacks via API or Frontend. This guide covers both methods, including a step-by-step Frontend tutorial for managing disputes. - Checkout - [Web Checkout](https://docs.localpayment.com/docs/dashboard-webcheckout.md): Learn how to generate payment requests using the Web Checkout feature in the Localpayment Business Portal. - [Payment Links](https://docs.localpayment.com/docs/dashboard-payment-links.md): The Link Payment feature lets you create instant payment requests without coding. Streamline your checkout process and accept payments directly from your platform. - [Frequent Items](https://docs.localpayment.com/docs/dashboard-frequent-items.md): Learn how to manage your Frequent Items library in Localpayment Business Portal, including adding products, creating categories, and organizing items for webcheckout and link payment transactions. - [Iframe Keys](https://docs.localpayment.com/docs/dashboard-iframe-keys.md): Learn how to create and manage iframe keys for embedded checkout integration in the Localpayment Business Portal - [Smart Fields Api Keys](https://docs.localpayment.com/docs/dashboard-smart-fields-api-keys.md): Step-by-step guide to generating and managing your Smart Fields API key in the Localpayment business portal. - [Appearance Customization](https://docs.localpayment.com/docs/dashboard-appearance-customization.md): Customize the visual appearance of your checkout components by personalizing the color scheme of your iframes and payment links to match your brand identity. - Payouts - [Create batch payout](https://docs.localpayment.com/docs/dashboard-create-batch-payout.md): The batch payout feature enables efficient payment processing by allowing you to upload multiple transactions simultaneously through a file. This streamlined approach saves time and reduces errors… - [Review a payout](https://docs.localpayment.com/docs/dashboard-review-payout.md): Manage all pending payout batch requests directly from the Localpayment Business Portal, where you can consult, authorize, or cancel them. - [Activity report](https://docs.localpayment.com/docs/dashboard-payout-activity-report.md): Review the history of your uploads. You can filter and check their details based on processing status and date. - [Proof of Payment (POP)](https://docs.localpayment.com/docs/dashboard-payout-proof-of-payment.md): The Proof of Payment (POP) is an essential document that serves as official confirmation of completed payout transactions. This guide will walk you through the process of accessing and downloading… - Settlement & Exchange - Internal Transfers - [Create Internal Transfer](https://docs.localpayment.com/docs/dashboard-create-internal-transfer.md): Internal transfers allow you to move funds between accounts within the Localpayment platform efficiently and securely. This guide walks you through the process of creating internal transfers, whether… - [Internal Transfer Activity](https://docs.localpayment.com/docs/dashboard-internal-transfer-activity.md): The Internal Transfer Activity page provides a comprehensive view of all internal fund movements between accounts. - Currency Exchange - [Create Currency Exchange](https://docs.localpayment.com/docs/dashboard-create-currency-exchange.md): The Currency Exchange feature allows you to convert funds between different currencies across your accounts in the same country, all within the Localpayment platform. This guide walks you through the… - [View Currency Exchange Activity](https://docs.localpayment.com/docs/dashboard-view-currency-exchange-activity.md): Your central hub for all foreign exchange activity. Track, monitor, and manage every FX movement between accounts with complete visibility and control. - [Wire Out](https://docs.localpayment.com/docs/dashboard-wire-out.md): Transfer funds seamlessly from your Localpayment account to your external banks using the Wire Out function within your Business Portal. - Wire In - [Create a Wire In](https://docs.localpayment.com/docs/dashboard-create-a-wire-in.md): Learn how to notify Localpayment of a deposit. After notification and processing, your funds will be credited and ready for payouts or exchange. - [Wire In Activity](https://docs.localpayment.com/docs/dashboard-wire-in-activity.md): Gain full visibility and control over your incoming wire in transactions. Track statuses, monitor for issues, and manage transactions efficiently. - Configurations - Clients - [Clients information](https://docs.localpayment.com/docs/dashboard-clients-information.md): This guide will walk you through the steps to find your official company details. - [Payment Accounts](https://docs.localpayment.com/docs/payment-accounts.md): Add, manage, and review your bank accounts and crypto wallet accounts from the Payment Accounts tab. - [Roles](https://docs.localpayment.com/docs/dashboard-roles.md): Define and manage custom user roles within the Localpayment Business Portal. This guide shows you how to create, edit, and delete roles, granting granular control over permissions to securely manage… - [External Users](https://docs.localpayment.com/docs/dashboard-external-users.md): Add new users and manage existing ones for your account. Control their capabilities by assigning specific roles, ensuring secure and appropriate access to business portal functions. - [Whitelist your IP](https://docs.localpayment.com/docs/dashboard-whitelist-your-ips.md): Secure your Localpayment API with IP whitelisting. Restrict access to trusted IP addresses only and automatically block unauthorized requests. - [Webhooks](https://docs.localpayment.com/docs/dashboard-webhooks.md): Webhooks/Callbacks allow Localpayment to send real-time notifications to your server about events such as transaction updates, payment status changes, and more. This guide will walk you through the… - [Notifications Reports](https://docs.localpayment.com/docs/dashboard-notifications-reports.md): Automate your reporting by configuring SFTP uploads or Email deliveries through the Localpayment Business Portal. - [Low Balance Alerts](https://docs.localpayment.com/docs/dashboard-low-balance-alerts.md): Configure automated notifications in the Localpayment Business Portal to prevent overdrafts, avoid fees, and manage your finances proactively. - [Whitelist Your BINs](https://docs.localpayment.com/docs/dashboard-whitelist-your-bins.md): Learn how to configure BIN whitelisting in Localpayment Business Portal to enhance transaction security and prevent fraud by allowing only pre-approved Bank Identification Numbers. - [Masters Reference Lists](https://docs.localpayment.com/docs/dashboard-masters-reference-lists.md): In the Masters section, you can access comprehensive reference lists that are essential for configuring and managing your payment operations. ## Guides: COMPLIANCE & SECURITY - [Compliance](https://docs.localpayment.com/docs/compliance.md): Localpayment maintains a comprehensive compliance framework aligned with global regulatory requirements. - [Licenses](https://docs.localpayment.com/docs/licenses.md): Localpayment's operating licenses and regulatory registrations by country, with the supervising authority for each market. - [Data Protection](https://docs.localpayment.com/docs/data-protection.md): or Localpayment, data protection is the foundation of trust and a catalyst for growth. Our world-class, multi-layered security safeguards client data across every step of the payment journey. - Entities (KYC/KYB) - [KYB Requirements for Virtual Account Beneficiaries](https://docs.localpayment.com/docs/kyb-requirements-for-sub-merchants-and-virtual-account-end-beneficiaries.md): The KYB information Localpayment must collect about your sub-merchants and Virtual Account beneficiaries to meet regulatory and compliance requirements. - [Share KYB Information through Entities](https://docs.localpayment.com/docs/share-kyb-information-through-entities.md): Send the KYB information of a sub-merchant with the Entities API: the company, its owners, its legal representative, and their documents. - [Entities Overview](https://docs.localpayment.com/docs/entities-overview.md): Register the people and companies you work with, attach their KYC/KYB evidence, and follow the review performed by Localpayment. - [Create an Entity](https://docs.localpayment.com/docs/create-an-entity.md): Register a person or a company with its minimum KYC data and its primary document, the first step of a KYC/KYB onboarding. - [Upload Documents and Proofs](https://docs.localpayment.com/docs/upload-documents-and-proofs.md): Declare supporting documents for an entity and upload the files (proofs) that Localpayment reviews during KYC/KYB. - [Track the Review and Fix Rejections](https://docs.localpayment.com/docs/track-review-and-fix-rejections.md): Request the KYC/KYB review of an entity, read the outcome, and correct what Localpayment asks for. - [Manage UBOs](https://docs.localpayment.com/docs/manage-ubos.md): Link the ultimate beneficial owners (UBOs) of a company entity, update their ownership and role, and end links that no longer apply. - [Custom Fields](https://docs.localpayment.com/docs/custom-fields.md): Store the extra KYC/KYB data agreed with Localpayment in attributes, validated against the custom-fields schema of your merchant. ## API Reference: LOCALPAYMENT API - [API Basics](https://docs.localpayment.com/reference/api-basics.md): Welcome to the Localpayment API documentation. Our REST API enables you to integrate payment processing capabilities directly into your applications, websites, and platforms with comprehensive payin… - [Transaction Status & Error Codes](https://docs.localpayment.com/reference/transaction-status-error-codes.md): This section details the API response formats, HTTP status codes, and a comprehensive reference of all transaction status and error codes used by the Localpayment API. Mastering these response… - [Chargeback](https://docs.localpayment.com/reference/chargeback-status-error-codes.md): A chargeback is initiated by the cardholder's bank and reverses a previous Payin. Each chargeback transaction moves through a series of statuses as it progresses from receipt to resolution. - [Credit](https://docs.localpayment.com/reference/credit-status-error-codes.md): Credit transaction statuses represent the outcome of operations performed using credit cards. These include refunds, investments, and collections. - [Currency Exchange](https://docs.localpayment.com/reference/currency-exchange-status-error-codes.md): Currency exchange transactions represent the conversion of funds from one currency to another between two accounts. Each transaction moves through a series of statuses as it is processed. - [Debit](https://docs.localpayment.com/reference/debit-status-error-codes.md): Debit transactions represent operations performed using debit cards. - [Expenses](https://docs.localpayment.com/reference/expenses-status-error-codes.md): Expenses track costs associated with operations (e.g., fees). - [Payin](https://docs.localpayment.com/reference/payin-status-error-codes.md): Payin transactions represent funds being deposited into your Localpayment account. - [Payout](https://docs.localpayment.com/reference/payout-status-error-codes.md): Payout transactions represent funds being sent from your Localpayment account to beneficiaries. Each payout moves through a series of statuses as it is processed, and may be rejected, returned, or… - [Recall](https://docs.localpayment.com/reference/recall-status-error-codes.md): Recalls are requests to reverse a payment, typically used in specific payment methods or regions. - [Recurring Fee](https://docs.localpayment.com/reference/recurring-fee-status-error-codes.md): Recurring Fees are charges related to subscription or account maintenance. - [Refund](https://docs.localpayment.com/reference/refund-status-error-codes.md): Refunds represent the return of funds to a customer for a specific, previously completed Payin. - [Return](https://docs.localpayment.com/reference/return-status-error-codes.md): A Return typically indicates a payment that was sent but could not be delivered to the recipient. This is distinct from a Refund (initiated by the merchant) or a Chargeback (initiated by the… - [Subscriptions](https://docs.localpayment.com/reference/subscriptions-status-error-codes.md): Subscription statuses track recurring payment arrangements, not individual payments. Individual payment attempts within a subscription are treated as Payin transactions. - [Wire In](https://docs.localpayment.com/reference/wire-in-status-error-codes.md): Wire In transactions represent incoming wire transfers. - [Wire Out](https://docs.localpayment.com/reference/wire-out-status-error-codes.md): Wire Out transactions represent outgoing wire transfers. - Data Types & Enums - [Country Codes](https://docs.localpayment.com/reference/country-codes.md): This document provides a comprehensive reference for ISO 3166-1 alpha-3 country codes supported by Localpayment. These three-letter codes are international standards that ensure consistent… - [Currency Codes](https://docs.localpayment.com/reference/currency-codes.md): This document provides a comprehensive reference of currency codes supported by Localpayment, following the ISO 4217 international standard for currency representation. - [Concept Codes](https://docs.localpayment.com/reference/concept-codes.md): This document outlines the concept codes available within the Localpayment system, as detailed in the table below. - [Identity Document Types](https://docs.localpayment.com/reference/identity-document-types.md): Reference table of accepted identity document types per country for use with the Validate Identity Document endpoint and payer/beneficiary fields. - [Get Available Payment Methods](https://docs.localpayment.com/reference/get-available-payment-methods.md): Get a complete overview of the payment methods available for each of your Localpayment accounts in a single request. > **NOTE** > > Omitting the `accountNumber` parameter returns all available… - [Postman Collection](https://docs.localpayment.com/reference/postman-collection.md): Streamline your API testing and integration with Localpayment's official Postman collection. This comprehensive collection provides pre-configured requests for all our endpoints, making it easy to… ## API Reference: BEFORE A PAYMENT - Authentication - [Authentication Overview](https://docs.localpayment.com/reference/authentication-overview.md): Localpayment uses OAuth 2.0 Bearer token authentication to secure API access. All API requests require a valid access token included in the `Authorization` header. This guide provides an overview of… - [Get Access Token](https://docs.localpayment.com/reference/get-token.md): To access any of our services, you must first authenticate by obtaining an access token. Use your dashboard username and password to request the token. > **Token Expiration** > > For security… - [Refresh Access Token](https://docs.localpayment.com/reference/refresh-token.md): Access tokens have a limited lifespan. If your token has expired, you can use this endpoint to generate a new one using a valid refresh token. > **Refresh Token expiration** > > Refresh tokens… - Validation Services - [Validate Identity Document](https://docs.localpayment.com/reference/validate-identity-document.md): Validate customer identity documents by country and type to ensure correct formatting. Use this endpoint to reduce transaction failures caused by invalid or incorrect document details. - [Validate Bank Account](https://docs.localpayment.com/reference/validate-bank-account.md): Prevent transaction failures by validating bank account formats against country-specific rules. This endpoint ensures accuracy before initiating a transfer. - [Get BIN Information](https://docs.localpayment.com/reference/get-bin-info.md): Validate a Bank Identification Number (BIN) to check card validity and retrieve key details like issuer, brand, type, and country. Use this check to prevent payment failures from invalid card… - Resources - [Get Bank Codes](https://docs.localpayment.com/reference/get-bank-codes.md): This endpoint provides the valid bank codes required to create a PayIn or PayOut transaction within the Localpayment system. - [Get National Holidays](https://docs.localpayment.com/reference/get-holidays.md): Retrieve a list of national holidays for the countries where you operate. Use this endpoint to anticipate payment processing delays and plan transactions accordingly. - [Get Alias Detail](https://docs.localpayment.com/reference/get-alias-detail.md): Check whether a payout alias is active and see the masked owner details before sending a payout. Currently available for Colombia only. ## API Reference: ENTITIES - Entities - [Create an Entity](https://docs.localpayment.com/reference/create-entity.md): Registers a natural person (INDIVIDUAL) or a legal entity (COMPANY) with its identifying document. - [List Entities](https://docs.localpayment.com/reference/list-entities.md): Returns a paginated list of your entities. - [Get an Entity](https://docs.localpayment.com/reference/get-entity.md): Returns the full entity: KYC data, declared documents with their active proofs, derived statuses and, for a COMPANY, the UBO summary. - [Update an Entity](https://docs.localpayment.com/reference/update-entity.md): Partially updates KYC data, address and custom fields. - [Close an Entity](https://docs.localpayment.com/reference/close-entity.md): Logically closes the entity: status becomes CLOSED, the record is kept and stays readable by id and with includeClosed=true. - [Request Verification](https://docs.localpayment.com/reference/request-entity-verification.md): Tells Localpayment that the documentation upload of the entity is complete and starts its review. The entity moves from PENDING_KYC to IN_REVIEW. - [Get KYC Status](https://docs.localpayment.com/reference/get-kyc-status.md): Returns a compact tree of the review state: entity status, documentation coverage, the status of every document and active proof, and the reason of the last... - [Get Status History](https://docs.localpayment.com/reference/get-entity-status-history.md): Returns the history of status transitions of the entity, with the actor, the reason and the correlation id of each change. - Documents - [Add a Document](https://docs.localpayment.com/reference/add-entity-document.md): Declares an additional document for an existing entity: a proof of address, articles of incorporation, a power of attorney or any other supporting document. - [List Documents](https://docs.localpayment.com/reference/list-entity-documents.md): Lists the declared documents of an entity with the overall documentationStatus. - [Get a Document](https://docs.localpayment.com/reference/get-entity-document.md): Returns one declared document with its derived status and active proofs. - [Update a Document](https://docs.localpayment.com/reference/update-entity-document.md): Updates issuing data of a declared document. - [Delete a Document](https://docs.localpayment.com/reference/delete-entity-document.md): Removes a non-primary document and its files. - Proofs - [Upload a Proof](https://docs.localpayment.com/reference/upload-proof.md): Uploads the file that supports a declared document (image of an ID, PDF of a proof of address, articles of incorporation). - [List Proofs of a Document](https://docs.localpayment.com/reference/list-document-proofs.md): Lists the current proofs of a document (replaced and deleted files are excluded). - [Get a Proof](https://docs.localpayment.com/reference/get-proof.md): Returns the metadata of a proof and a short-lived signed downloadUrl to fetch the file. - [Download a Proof File](https://docs.localpayment.com/reference/download-proof-file.md): Redirects to the signed URL of the file. - [Delete a Proof](https://docs.localpayment.com/reference/delete-proof.md): Deletes a file uploaded by mistake. - UBOs - [Link a UBO](https://docs.localpayment.com/reference/link-ubo.md): Links an INDIVIDUAL entity as ultimate beneficial owner (UBO) of a COMPANY entity, with the ownership percentage and control role. - [List UBOs of a Company](https://docs.localpayment.com/reference/list-company-ubos.md): Lists the active UBO links of a company, ordered by creation date. - [Update a UBO](https://docs.localpayment.com/reference/update-ubo.md): Changes the ownership percentage and/or the control role of an active link. - [End a UBO Link](https://docs.localpayment.com/reference/end-ubo-link.md): Ends an active UBO link by setting validTo to today. - [List Companies of a Person](https://docs.localpayment.com/reference/list-person-ubo-companies.md): Lists the companies in which an INDIVIDUAL is an active UBO. - [Get Custom Fields Schema](https://docs.localpayment.com/reference/get-custom-fields-schema.md): Returns the published custom-fields schema of your merchant, as JSON Schema (default) or as Localpayment's native field definition (?format=definition). - [Entity Statuses and Error Codes](https://docs.localpayment.com/reference/entity-statuses-and-error-codes.md): Lifecycle statuses, derived document and proof statuses, the error format, and the error code catalog of the Entities API. - [Document and Proof Types](https://docs.localpayment.com/reference/entity-document-and-proof-types.md): Catalog of document type values accepted by the Entities API, the proofType values of their files, and the file constraints. ## API Reference: PAYINS - [Create Payin](https://docs.localpayment.com/reference/payins.md): This endpoint initiates a Payin transaction, allowing you to collect payments from customers using various payment methods. You can specify details such as the payment method, amount, currency, and… - Cards - [Tokenize Card](https://docs.localpayment.com/reference/tokenize-card.md): This endpoint securely tokenizes a card, replacing sensitive card details with a unique token. The token can be used for future transactions, ensuring compliance with security standards (e.g., PCI… - [Get Card Details](https://docs.localpayment.com/reference/get-card.md): This endpoint retrieves the details of a previously tokenized card. You can use this endpoint to confirm that a card has been successfully tokenized and to access the tokenized card details, such as… - [Delete Tokenized Card](https://docs.localpayment.com/reference/delete-card.md): This endpoint deletes a previously tokenized card, permanently removing the token and its associated card details from your account. This action cannot be undone. - Installments - [Generate Installment Plan Quote](https://docs.localpayment.com/reference/installments-plan-quote.md): This endpoint generates a quote for an installment plan. > **Note* > > Installment plans are only available for credit card payments. **Currency Considerations:** The currency used for the… - [Create Installment Plan](https://docs.localpayment.com/reference/installments.md): This endpoint creates an installment plan for a Payin transaction, allowing you to offer customers the flexibility to pay for their purchases in installments. You can specify the number of… - [Capture Authorized Payin](https://docs.localpayment.com/reference/capture-payin.md): This endpoint captures funds for a Payin transaction that has been authorized but not yet settled. This completes the payment process and transfers the funds to your account. > **Note** > > A credit… - [Cancel Payin Authorization](https://docs.localpayment.com/reference/cancel-authorization.md): This endpoint cancels the authorization of a previously authorized Payin transaction, preventing the funds from being captured. This is useful if you need to reverse an authorization before it… - Virtual Accounts - [Create a Virtual Account](https://docs.localpayment.com/reference/create-virtual-account.md): This endpoint allows you to create multiple virtual accounts to receive local ACH bank transfers. By assigning these accounts to specific merchants or end users, you can streamline the reconciliation… - [Get Virtual Account Status](https://docs.localpayment.com/reference/get-virtual-account-status.md): This endpoint retrieves the status and details of a specific virtual account that you previously created using the [Create a Virtual Account](/reference/create-virtual-account) endpoint. You can use… - [Enable or Disable a Virtual Account](https://docs.localpayment.com/reference/update-virtual-account-status.md): This endpoint allows you to temporarily enable or disable a virtual account. Use it to suspend a specific account from receiving new funds (disable) or to reactivate it so it can accept payments… - [Delete a Virtual Account](https://docs.localpayment.com/reference/delete-virtual-account.md): Permanently deactivate a virtual account. This operation disables the account from receiving any future payments, but all its historical records and transaction data are preserved for compliance and… - [Create Virtual Accounts in Batch](https://docs.localpayment.com/reference/request-batch.md): This endpoint enables you to create multiple virtual accounts simultaneously, streamlining the account creation process when dealing with a large number of accounts. You can create virtual accounts… - [Simulate a Virtual Account Payment](https://docs.localpayment.com/reference/simulate-payin-to-virtual-account.md): This endpoint allows you to simulate an incoming payment to a virtual account. **Available only in the Stage environment.** It is designed for merchants to test their integration's end-to-end flow,… - [Get Status of Virtual Accounts in Batch](https://docs.localpayment.com/reference/get-virtual-account-status-batch.md): This endpoint retrieves the status and details of a batch of virtual accounts that you previously created using the [Create Virtual Accounts in Batch](/reference/request-batch) endpoint. This allows… - Virtual Account Alias - [Create an Alias to a Virtual Account](https://docs.localpayment.com/reference/create-an-alias-to-a-virtual-account.md): **Availability: Argentina** This operation allows merchants to associate a custom, human-readable alias (CVU alias) with an existing active virtual account in Argentina. An alias replaces the… - Subscriptions - [Create a Subscription](https://docs.localpayment.com/reference/create-a-subscription.md): This endpoint allows you to create a new subscription for a customer. Creating a subscription involves associating a customer with a specific subscription plan and recording their payment information. - [Check Subscription](https://docs.localpayment.com/reference/get-api-subscriptions-externalid.md) - [Update a Subscription](https://docs.localpayment.com/reference/update-subscription.md): This service allows you to update your subscription details, ensuring uninterrupted continuity of your recurring payments. - [Cancel a Subscription](https://docs.localpayment.com/reference/cancel-subscription.md): Use this endpoint to cancel an existing subscription. This action will prevent any future recurring payments associated with the subscription. **Important Notes:** * Cancellation may not result in… - [Upload Documents to Dispute a Chargeback](https://docs.localpayment.com/reference/upload-documents-to-dispute-a-chargeback.md): Upload the necessary documentation to challenge a chargeback. This endpoint allows you to submit evidence and supporting materials to dispute a transaction charge. - [Refund a Payin](https://docs.localpayment.com/reference/refund-a-payin.md): This endpoint allows you to fully refund a previously authorized Payin transaction. **Refund Requirements**: * The refund amount must match the original Payin amount. * The refund must be sent to… - [Download Refund Proof of Payment](https://docs.localpayment.com/reference/download-refund-proof-of-payment.md): Download a Proof of Payment (POP) document for one or more completed Refund transactions. - [Cancel a Payin](https://docs.localpayment.com/reference/cancel-payin.md): This endpoint allows you to cancel a Payin transaction that is in an authorized state. The transaction will be marked as cancelled and any pending funds will be released. - [Create Wire Out](https://docs.localpayment.com/reference/wire-out.md): Initiate a **Wire Out** to settle funds from your Localpayment account to your own external bank account. > 📌 **Wire Out vs. Payout** > > * A **Wire Out** is a **settlement / withdrawal**: funds… ## API Reference: SMART FIELDS - [Including Localpayment SDK](https://docs.localpayment.com/reference/smart-fields-including-localpayment-sdk.md): Localpayment Smart Fields provide a secure and seamless way to collect sensitive payment information directly on your website while reducing PCI DSS compliance scope. This guide explains how to… - [The Localpayment Object](https://docs.localpayment.com/reference/smart-fields-the-localpayment-object.md): The Localpayment object is your entry point to the Smart Fields SDK. It provides methods to create payment fields, handle tokens, and manage the payment flow. This object is created by calling the… - [The Fields Object](https://docs.localpayment.com/reference/smart-fields-the-fields-object.md): Explore the Fields Object for creating payment forms. This reference details fields.create(), field.mount(), and event handling. - [The Field container](https://docs.localpayment.com/reference/smart-fields-the-field-container.md): The field container is the DOM element where Smart Fields are rendered and managed. Proper container setup is essential for ensuring optimal performance, security, and user experience. ## API Reference: PAYOUTS - [Create Payout](https://docs.localpayment.com/reference/create-a-payout.md): Initiate seamless payouts from your Localpayment account to any beneficiary with a single API call. This endpoint enables you to transfer funds to customers, vendors, or partners by providing… - [Authorize Payout](https://docs.localpayment.com/reference/authorize-payout.md): Authorize a payout to release funds to your beneficiary by updating its status to `Received`. This endpoint is designed to approve payouts that are in a `pending` or `on-hold` state. You can… - [Cancel Payout](https://docs.localpayment.com/reference/void-a-payout.md): Cancel a payout to prevent funds from being transferred. Use this to stop transactions that were created in error or require correction. > **Note** > > You can only cancel payouts with a status of… - [Create Wire In](https://docs.localpayment.com/reference/wire-in.md): Receive funds from an external bank account directly into your Localpayment account via wire transfer. This endpoint is ideal for accepting payments from customers or partners using traditional… - [Download Payout Proof of Payment](https://docs.localpayment.com/reference/download-payout-proof-of-payment.md): Download a Proof of Payment (POP) document for one or more completed Payout transactions. ## API Reference: TREASURY & FX - FX Services - [Get FX Quote](https://docs.localpayment.com/reference/currency-exchange-quote.md): This endpoint generates a secure currency exchange quote, locking in the FX rate, validity time frame, and a unique token for payment processing. By default, quotes refresh every 60 seconds, but… - [Create Bulk FX Conversion](https://docs.localpayment.com/reference/exchange-bulk.md): Use the Bulk Currency Exchange API to efficiently convert funds between your own multi-currency accounts within the same country. This is ideal for businesses managing international operations to… - [Create Internal Transfer](https://docs.localpayment.com/reference/domestic-transfer.md): Efficiently manage your internal finances by transferring funds between your own Localpayment accounts, both domestically and internationally. Use this endpoint to consolidate balances, allocate… - Reports - [Get Account Balance](https://docs.localpayment.com/reference/get-current-account-balance.md): Retrieve the current balance, available funds, and currency for your Localpayment accounts. Use this real-time data to power account dashboards, simplify reconciliation, and inform your fund… - [Get Account Reconciliation](https://docs.localpayment.com/reference/get-account-reconciliation-details.md): Generate detailed reports of all completed transactions within a specific period. This endpoint is designed for accounting, auditing, and financial reconciliation. - Transactions - [Get Transaction](https://docs.localpayment.com/reference/get-transactions-externalid.md): Get a complete transaction overview with status, amount, payer information, and payment details for full payment visibility and simplified tracking. - [List Transactions](https://docs.localpayment.com/reference/get-payment-transactions.md): Retrieve detailed transaction records for any date range. Filter by type or status to quickly isolate specific payments, refunds, and other activities for reporting and analysis. - [Get Transaction Status](https://docs.localpayment.com/reference/get-transaction-status.md): Get real-time status updates for any transaction associated with your Localpayment account to monitor its current progress.