# OneKey Payments Docs

## OKP Documentation

- [OKP APIs](https://apidocs.onekeypayments.com/readme.md): Welcome to OKP APIs documentation page.
- [Getting Started with OKP](https://apidocs.onekeypayments.com/getting-started-with-okp.md): Get started with OKP by creating your own account on our Merchant Panel!
- [Deposits API](https://apidocs.onekeypayments.com/api-documentation/deposits-api.md): Our latest Deposits API is focused on simplicity, usability and personalization and it is used to allow your customers to deposit with their local payment methods of preference.
- [Technical and Security Aspects](https://apidocs.onekeypayments.com/api-documentation/deposits-api/technical-and-security-aspects.md): Learn about the technical and security aspects of our Deposits APIs
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-documentation/deposits-api/technical-and-security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Endpoints](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints.md): Learn how to integrate all of our Deposits endpoints
- [Deposit Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/deposit-creation-endpoint.md): Learn how to generate deposits
- [Notifications](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/deposit-creation-endpoint/notifications.md): Learn about how the notifications for deposits works
- [Transactional Account Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/transactional-account-endpoint.md): This endpoint allows you to check your balance between your proprietary and transactional accounts, and also move balance freely from one to another.
- [Understanding the Solution](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/transactional-account-endpoint/understanding-the-solution.md): This solution allows having a transactional account, and an proprietary account, managing different balances, and also a bank account check solution.
- [PCI Deposit Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/pci-deposit-creation-endpoint.md): Learn how to use the PCI Deposit endpoint to create One Shot payments with credit cards
- [Deposit Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/deposit-status-endpoint.md): Retrieve the status of a previously created deposit
- [Payment Methods Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/payment-methods-endpoint.md): The Payment Methods endpoint allows you to retrieve the complete list of payment methods you have available for the country specified
- [Currency Exchange Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/currency-exchange-endpoint.md): The Currency Exchange endpoint allows you to get the exchange of any local currency compared against USD
- [Crypto Exchange Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/crypto-exchange-endpoint.md): The Crypto Exchange endpoint allows you to get the exchange of any cryptocurrency compared against USD or any other local currency
- [Country States Codes Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/country-states-codes-endpoint.md): Learn how to use the Country States Codes Endpoint to retrieve the list of States ISO codes in each country
- [Refund Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/refund-creation-endpoint.md): Create refunds requests from a completed deposit
- [Notifications](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/refund-creation-endpoint/notifications.md): Learn about how the notifications for refunds works
- [Refund Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/deposits-api/endpoints/refund-status-endpoint.md): Retrieve the status of a previously created refund
- [Payment Methods](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods.md): Learn about our Payment Methods
- [America](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america.md): Check the list of Payment Methods available on each American country
- [Bolivia](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/bolivia.md): Check the list of Payment Methods available on Bolivia
- [Brazil](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/brazil.md): Check the list of Payment Methods available on Brazil
- [PIX Biometric](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/brazil/pix-biometric.md): Our groundbreaking solution that enables easier and faster Pix payments, boosting conversion rates and eliminating friction in the checkout process. No manual steps. Just verify and pay.
- [Chile](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/chile.md): Check the list of Payment Methods available on Chile
- [Canada](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/canada.md): Check the list of Payment Methods available on Canada
- [Colombia](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/colombia.md): Check the list of Payment Methods available on Colombia
- [Costa Rica](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/panama.md): Check the list of Payment Methods available on Costa Rica
- [Ecuador](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/ecuador.md): Check the list of Payment Methods available on Ecuador
- [Guatemala](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/guatemala.md): Check the list of Payment Methods available on Guatemala
- [Honduras](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/honduras.md): Check the list of Payment Methods available on Honduras
- [Mexico](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/mexico.md): Check the list of Payment Methods available on Mexico
- [Panama](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/panama-1.md): Check the list of Payment Methods available on Panama
- [Paraguay](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/paraguay.md): Check the list of Payment Methods available on Paraguay
- [Peru](https://apidocs.onekeypayments.com/api-documentation/deposits-api/payment-methods/america/peru.md): Check the list of Payment Methods available on Perú
- [API Codes](https://apidocs.onekeypayments.com/api-documentation/deposits-api/api-codes.md): Learn about the API Codes returned by our APIs
- [Cashouts API](https://apidocs.onekeypayments.com/api-documentation/cashouts-api.md): Cashouts API v3 Introduction
- [Technical and Security Aspects](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/technical-and-security-aspects.md): Technical and Security Aspects of our V3 Cashout endpoints
- [Calculating the Payload-Signature](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/technical-and-security-aspects/calculating-the-payload-signature.md): Learn how to correctly calculate the Signature Control String to authenticate with the V3 Cashout endpoints
- [Endpoints](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints.md): Learn how to integrate all of our Cashouts endpoints
- [Cashout Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-creation-endpoint.md): Learn how to generate cashouts request by using our Cashout API v3 directly from your website
- [Notifications](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-creation-endpoint/notifications.md): Learn about how the notifications of the Cashout API v3 work
- [Cashout Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-status-endpoint.md): Learn how to use the Endpoint to retrieve the status of a cashout
- [Cashout Update Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/update-status-endpoint.md): Learn how to use the endpoint to update the status of a cashout
- [Cashout Cancellation Endpoint](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-cancel-endpoint.md): Learn how to use the Cashout Cancellation Endpoint to cancel cashouts when needed
- [Cashout Bank Codes](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-bank-codes.md): Learn how to use the Cashout Bank Codes Endpoint to retrieve the list of bank codes accepted for cashouts in each country
- [Countries Validations](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations.md): Learn about the cashouts requirements and validations made over each country in which we operate on.
- [American Countries](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries.md): Learn about the cashouts validations of the American countries
- [Bolivia](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/bolivia.md): Check the requirements and validations made over the cashouts on Bolivia
- [Brazil](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/brazil.md): Check the requirements and validations made over the cashouts on Brazil
- [Canada](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/canada.md): Check the requirements and validations made over the cashouts on Canada
- [Chile](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/chile.md): Check the requirements and validations made over the cashouts on Chile
- [Colombia](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/colombia.md): Check the requirements and validations made over the cashouts on Colombia
- [Ecuador](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/ecuador.md): Check the requirements and validations made over the cashouts on Ecuador
- [Mexico](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/mexico.md): Check the requirements and validations made over the cashouts on Mexico
- [Paraguay](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/paraguay.md): Check the list of Payment Methods available on Paraguay
- [Peru](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/countries-validations/american-countries/peru.md): Check the requirements and validations made over the cashouts on Peru
- [API Codes](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/api-codes.md): Learn about the API Codes returned by our Cashouts APIs
- [Subscriptions API](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api.md)
- [Technical and Security Aspects](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/technical-and-security-aspects.md): Learn about the technical and security aspects of our Deposits APIs
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/technical-and-security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Subscription Creation Endpoints](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-creation-endpoints.md)
- [OneShot Subscription Creation](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-creation-endpoints/oneshot-subscription-creation.md): The OneShot flow is designed for merchants who are not PCI compliant and cannot handle payment card data directly.
- [PCI Subscription Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-creation-endpoints/pci-subscription-creation-endpoint.md)
- [Notifications](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-creation-endpoints/notifications.md): Learn about how the notifications for deposits works
- [Subscription Cancellation Endpoint](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-cancellation-endpoint.md)
- [Subscription Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/subscriptions-api/subscription-status-endpoint.md): This documentation details the endpoint used to retrieve the current status and information of existing subscriptions in our system.
- [Automatic PIX API](https://apidocs.onekeypayments.com/api-documentation/automatic-pix-api.md)
- [Enrollment Creation Endpoint](https://apidocs.onekeypayments.com/api-documentation/automatic-pix-api/enrollment-creation-endpoint.md)
- [Recurring Payment Endpoint](https://apidocs.onekeypayments.com/api-documentation/automatic-pix-api/recurring-payment-endpoint.md)
- [Enrollment Status Endpoint](https://apidocs.onekeypayments.com/api-documentation/automatic-pix-api/enrollment-status-endpoint.md)
- [Cancel Enrollment Endpoint](https://apidocs.onekeypayments.com/api-documentation/automatic-pix-api/cancel-enrollment-endpoint.md)
- [Quickpay](https://apidocs.onekeypayments.com/api-documentation/quickpay.md): With QuickPay, merchants can start receiving payments from their customers first and ask them to signup then
- [Endpoints](https://apidocs.onekeypayments.com/api-documentation/quickpay/endpoints.md): Learn how to integrate QuickPay APIs
- [Deposit creation endpoint](https://apidocs.onekeypayments.com/api-documentation/quickpay/endpoints/deposit-creation-endpoint.md): Learn how to create deposits with QuickPay
- [Notifications](https://apidocs.onekeypayments.com/api-documentation/quickpay/endpoints/deposit-creation-endpoint/notifications.md): Learn about how the notifications for deposits works
- [Deposit status endpoint](https://apidocs.onekeypayments.com/api-documentation/quickpay/endpoints/deposit-status-endpoint.md): Retrieve the status of a previously created deposit
- [Bank Account Validation](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation.md): Bank Accounts Validation API Introduction
- [Technical and Security Aspects](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/technical-and-security-aspects.md): Learn about the technical and security aspects of our Bank Accounts Validation APIs
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/technical-and-security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Endpoints](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/endpoints.md)
- [Bank Account Validation Endpoint](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/endpoints/bank-account-validation-endpoint.md): Validate bank accounts in real time by using the Bank Account Validation Endpoint
- [Pix Key Validation and Details Endpoint](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/endpoints/bank-account-validation-endpoint/pix-key-validation-and-details-endpoint.md): Validate PIX Keys in real time, with their full banking details.
- [API Codes](https://apidocs.onekeypayments.com/api-documentation/bank-account-validation/api-codes.md): Learn about the API Codes returned by this API
- [Cards SDK](https://apidocs.onekeypayments.com/deposits-tools/cards-sdk.md): Learn the technical aspects about our Cards SDK, in order to have the ultimate native checkout experience.
- [With User Interface](https://apidocs.onekeypayments.com/deposits-tools/cards-sdk/with-user-interface.md): Learn the technical aspects about our Cards SDK, in order to have the ultimate native checkout experience.
- [Color Customization](https://apidocs.onekeypayments.com/deposits-tools/cards-sdk/with-user-interface/color-customization.md): Elevate your user experience with our advanced color customization feature. We provide a bespoke version of the theme to perfectly match the unique style of your websited's UI.
- [Without User Interface](https://apidocs.onekeypayments.com/deposits-tools/cards-sdk/without-user-interface.md): Learn how to use our SDK in Javascript to allow integrations with our Deposits APIs
- [Java SDK](https://apidocs.onekeypayments.com/deposits-tools/java-sdk.md): Learn how to use our SDK in Java to facilitate even further the integration with our Deposits APIs
- [PHP SDK](https://apidocs.onekeypayments.com/deposits-tools/php-sdk.md): Learn how to use our SDK in PHP to facilitate even further the integration with our Deposits APIs
- [Javascript Library](https://apidocs.onekeypayments.com/deposits-tools/javascript-library.md): Learn how to build and personalize your own custom cashiers by using our library in Javascript
- [Deposits with Cards SDK](https://apidocs.onekeypayments.com/knowledge-base/deposits-with-cards-sdk.md): Learn how to create Deposits with our Cards SDK for a seamless checkout experience.
- [With User Interface](https://apidocs.onekeypayments.com/knowledge-base/deposits-with-cards-sdk/with-user-interface.md)
- [Without User Interface](https://apidocs.onekeypayments.com/knowledge-base/deposits-with-cards-sdk/without-user-interface.md): This article aims to explain which are the steps for Creating a Deposit with Card Token, the tools and Endpoints involved and how each one of them should be used.
- [Countries Specifications](https://apidocs.onekeypayments.com/knowledge-base/countries-specifications.md): Learn how to validate the country's specific details
- [WooCommerce](https://apidocs.onekeypayments.com/plugins/woocommerce.md): Here you will find all the information and resources needed in order to install our WooCommerce plugin!
- [Installation](https://apidocs.onekeypayments.com/plugins/woocommerce/installation.md)
- [Configuration](https://apidocs.onekeypayments.com/plugins/woocommerce/configuration.md): If you have installed the plugin, follow this steps and tips to have it up and running!

## Guides

- [Welcome to OneKey Payments](https://apidocs.onekeypayments.com/guides/readme.md)
- [Getting started](https://apidocs.onekeypayments.com/guides/getting-started.md)
- [Get your API Keys](https://apidocs.onekeypayments.com/guides/getting-started/get-your-api-keys.md)
- [Important configurations](https://apidocs.onekeypayments.com/guides/getting-started/important-configurations.md)
- [Start testing](https://apidocs.onekeypayments.com/guides/getting-started/start-testing.md)
- [Go live](https://apidocs.onekeypayments.com/guides/getting-started/go-live.md)
- [Using LLMs with OneKey](https://apidocs.onekeypayments.com/guides/using-llms-with-onekey.md): Leverage LLMs for intelligent OneKey Payments API integration.
- [Overview](https://apidocs.onekeypayments.com/guides/deposits/overview.md)
- [Coverage](https://apidocs.onekeypayments.com/guides/deposits/payment-methods.md)
- [Template country page](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/template-country-page.md): This is a template page, while copy/pasting please remove all that do not apply.
- [America](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america.md)
- [Argentina](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/argentina.md)
- [Bolivia](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/bolivia.md)
- [Brazil](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/brazil.md)
- [Chile](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/chile.md)
- [Canada](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/canada.md)
- [Colombia](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/colombia.md)
- [Costa Rica](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/costarica.md): Check the list of Payment Methods available on Costa Rica
- [Dominican Republic](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/dominican-republic.md): Check the list of Payment Methods available on Dominican Republic
- [Ecuador](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/ecuador.md)
- [El Salvador](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/elsalvador.md): Check the list of Payment Methods available on El Salvador
- [Guatemala](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/guatemala.md)
- [Honduras](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/honduras.md): Check the list of Payment Methods available on Honduras
- [Mexico](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/mexico.md)
- [Nicaragua](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/nicaragua.md): Check the list of Payment Methods available on Nicaragua
- [Panama](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/panama.md): Check the list of Payment Methods available on Panama
- [Paraguay](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/paraguay.md)
- [Peru](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/america/peru.md)
- [Africa](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/africa.md)
- [Asia](https://apidocs.onekeypayments.com/guides/deposits/payment-methods/asia.md)
- [Solutions](https://apidocs.onekeypayments.com/guides/deposits/solutions.md)
- [Server2Server](https://apidocs.onekeypayments.com/guides/deposits/solutions/server2server.md)
- [Fragments (SDK)](https://apidocs.onekeypayments.com/guides/deposits/solutions/fragments-sdk.md)
- [Fragments (Lite)](https://apidocs.onekeypayments.com/guides/deposits/solutions/fragments-sdk/fragments-lite.md)
- [Fragments (all-in-one)](https://apidocs.onekeypayments.com/guides/deposits/solutions/fragments-sdk/fragments-all-in-one.md)
- [OneShot](https://apidocs.onekeypayments.com/guides/deposits/solutions/oneshot.md)
- [Plugins](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins.md)
- [Shopify](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify.md): Integrate D24 into your store to accept payments from your users.
- [Installation](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/installation.md)
- [Onboarding](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/onboarding.md)
- [Customer flow](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/customer-flow.md)
- [Admin Flow](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/admin-flow.md)
- [Tutorials](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/tutorials.md)
- [FAQ](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/shopify/faq.md)
- [WooCommerce](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/woocommerce.md): Here you will find all the information and resources needed in order to install our WooCommerce plugin!
- [Installation](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/woocommerce/installation.md)
- [Configuration](https://apidocs.onekeypayments.com/guides/deposits/solutions/plugins/woocommerce/configuration.md): If you have installed the plugin, follow this steps and tips to have it up and running!
- [Create deposits](https://apidocs.onekeypayments.com/guides/deposits/create-deposits.md)
- [Credit cards](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards.md)
- [Basic deposits](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits.md)
- [Server2Server](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/server2server.md)
- [Fragments Lite](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/fragments-lite.md)
- [Fragments all-in-one](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/fragments-all-in-one.md)
- [OneShot](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/oneshot.md)
- [3DS](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/3ds.md)
- [Installments](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/installments.md)
- [Card-on-file](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/card-on-file.md)
- [Subscriptions](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/subscriptions.md)
- [Authorization and capture](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/authorization-and-capture.md)
- [Bank transfers and cash vouchers](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/bank-transfers-and-cash-vouchers.md)
- [Notifications](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/notifications.md)
- [Status flow](https://apidocs.onekeypayments.com/guides/deposits/status-flow.md)
- [Countries specialization](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization.md)
- [Automatic Pix](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/automatic-pix.md)
- [Enrollment](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/automatic-pix/enrollment.md)
- [Recurring payments](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/automatic-pix/recurring-payments.md)
- [Brazilian Transactional Accounts](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/brazilian-transactional-accounts.md)
- [Biometric Pix](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/biometric-pix.md)
- [SPEI Offline](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/spei-offline.md)
- [Quickpay](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/quickpay.md)
- [Refund a deposit](https://apidocs.onekeypayments.com/guides/deposits/refund-a-deposit.md)
- [Status flow](https://apidocs.onekeypayments.com/guides/deposits/refund-a-deposit/status-flow.md)
- [Chargebacks](https://apidocs.onekeypayments.com/guides/deposits/chargebacks.md)
- [Overview](https://apidocs.onekeypayments.com/guides/cashouts/overview.md)
- [Countries validations](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations.md)
- [America](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries.md): Learn about the cashouts validations of the American countries
- [Argentina](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/argentina.md): Check the requirements and validations made over the cashouts on Argentina
- [Bolivia](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/bolivia.md): Check the requirements and validations made over the cashouts on Bolivia
- [Brazil](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/brazil.md): Check the requirements and validations made over the cashouts on Brazil
- [Canada](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/canada.md): Check the requirements and validations made over the cashouts on Canada
- [Chile](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/chile.md): Check the requirements and validations made over the cashouts on Chile
- [Colombia](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/colombia.md): Check the requirements and validations made over the cashouts on Colombia
- [Bre-B: Colombia’s Instant Payment System](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/colombia/bre-b-colombias-instant-payment-system.md)
- [Ecuador](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/ecuador.md): Check the requirements and validations made over the cashouts on Ecuador
- [Mexico](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/mexico.md): Check the requirements and validations made over the cashouts on Mexico
- [Paraguay](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/paraguay.md): Check the requirements and validations made over the cashouts on Paraguay
- [Peru](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/american-countries/peru.md): Check the requirements and validations made over the cashouts on Peru
- [Africa](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/african-countries.md): Learn about the cashouts validations of the African countries
- [Asia](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/asian-countries.md): Learn about the cashouts validations of the Asian countries
- [Oceania](https://apidocs.onekeypayments.com/guides/cashouts/countries-validations/oceania.md): Learn about the cashouts validations of the Asian countries
- [Create cashouts](https://apidocs.onekeypayments.com/guides/cashouts/create-cashouts.md)
- [API Integration](https://apidocs.onekeypayments.com/guides/cashouts/create-cashouts/api-integration.md)
- [Pay users via Merchant Panel](https://apidocs.onekeypayments.com/guides/cashouts/create-cashouts/pay-users-via-merchant-panel.md)
- [Notifications](https://apidocs.onekeypayments.com/guides/cashouts/create-cashouts/notifications.md)
- [Status flow](https://apidocs.onekeypayments.com/guides/cashouts/status-flow.md)
- [Overview](https://apidocs.onekeypayments.com/guides/platforms-booster/overview.md)
- [Onboarding](https://apidocs.onekeypayments.com/guides/platforms-booster/onboarding.md)
- [Notifications](https://apidocs.onekeypayments.com/guides/platforms-booster/notifications.md)
- [Manage Submerchants payments](https://apidocs.onekeypayments.com/guides/platforms-booster/manage-submerchants-payments.md)
- [Create a deposit](https://apidocs.onekeypayments.com/guides/platforms-booster/manage-submerchants-payments/create-a-deposit.md)
- [Create a cashout](https://apidocs.onekeypayments.com/guides/platforms-booster/manage-submerchants-payments/create-a-cashout.md)
- [Countries Specifications](https://apidocs.onekeypayments.com/guides/knowledge-base/countries-specifications.md): Learn how to validate the country's specific details

## API Reference

- [API Reference](https://apidocs.onekeypayments.com/api-reference/api-reference.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/deposits-api/security-aspects.md)
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-reference/deposits-api/security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Payment methods](https://apidocs.onekeypayments.com/api-reference/deposits-api/payment-methods.md)
- [Get payment methods](https://apidocs.onekeypayments.com/api-reference/deposits-api/payment-methods/get-payment-methods.md)
- [Manage payments](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-payments.md)
- [Create deposit](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-payments/create-deposit.md)
- [Create deposit (credit card operations)](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-payments/create-deposit-credit-card-operations.md)
- [Get deposit status](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-payments/get-deposit-status.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-payments/api-codes.md)
- [Saving cards (card-on-file)](https://apidocs.onekeypayments.com/api-reference/deposits-api/saving-cards-card-on-file.md)
- [Store a card](https://apidocs.onekeypayments.com/api-reference/deposits-api/saving-cards-card-on-file/store-a-card.md)
- [Retrieve a stored card](https://apidocs.onekeypayments.com/api-reference/deposits-api/saving-cards-card-on-file/retrieve-a-stored-card.md)
- [Delete a stored card](https://apidocs.onekeypayments.com/api-reference/deposits-api/saving-cards-card-on-file/delete-a-stored-card.md)
- [Manage subscriptions](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-subscriptions.md)
- [Create a subscription (OneShot)](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-subscriptions/create-a-subscription-oneshot.md)
- [Create a subscription (Server2Server)](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-subscriptions/create-a-subscription-server2server.md)
- [Get a subscription](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-subscriptions/get-a-subscription.md)
- [Cancel a subscription](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-subscriptions/cancel-a-subscription.md)
- [Manage refunds](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-refunds.md)
- [Create refund](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-refunds/create-refund.md)
- [Get refund status](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-refunds/get-refund-status.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/deposits-api/manage-refunds/api-codes.md)
- [Currency exchange](https://apidocs.onekeypayments.com/api-reference/deposits-api/currency-exchange.md)
- [Get currency exchange](https://apidocs.onekeypayments.com/api-reference/deposits-api/currency-exchange/get-currency-exchange.md)
- [Get crypto exchange](https://apidocs.onekeypayments.com/api-reference/deposits-api/currency-exchange/get-crypto-exchange.md)
- [Automatic Pix](https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix.md)
- [Create enrollment](https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix/create-enrollment.md)
- [Get enrollment status](https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix/get-enrollment-status.md)
- [Cancel an enrollment](https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix/cancel-an-enrollment.md)
- [Transactional Accounts](https://apidocs.onekeypayments.com/api-reference/deposits-api/transactional-accounts.md)
- [Move funds](https://apidocs.onekeypayments.com/api-reference/deposits-api/transactional-accounts/move-funds.md)
- [Get balance](https://apidocs.onekeypayments.com/api-reference/deposits-api/transactional-accounts/get-balance.md)
- [Overview](https://apidocs.onekeypayments.com/api-reference/fragment-sdk/overview.md): Learn the technical aspects about our Cards SDK, in order to have the ultimate native checkout experience.
- [All-in-one](https://apidocs.onekeypayments.com/api-reference/fragment-sdk/all-in-one.md)
- [Customize the UI](https://apidocs.onekeypayments.com/api-reference/fragment-sdk/all-in-one/customize-the-ui.md)
- [Lite](https://apidocs.onekeypayments.com/api-reference/fragment-sdk/lite.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/cashouts-api/security-aspects.md)
- [Calculating the Payload-Signature](https://apidocs.onekeypayments.com/api-reference/cashouts-api/security-aspects/calculating-the-payload-signature.md)
- [Banks](https://apidocs.onekeypayments.com/api-reference/cashouts-api/banks.md)
- [Get bank codes](https://apidocs.onekeypayments.com/api-reference/cashouts-api/banks/get-bank-codes.md)
- [Manage cashouts](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts.md)
- [Create a cashout](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/create-a-cashout.md)
- [Get a cashout status](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/get-a-cashout-status.md)
- [Cancel a cashout](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/cancel-a-cashout.md)
- [Update a cashout status](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/update-a-cashout-status.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/api-codes.md)
- [Validate bank accounts](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts/security-aspects.md)
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts/security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Bank account validator](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts/bank-account-validator.md)
- [Pix keys validator](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts/pix-keys-validator.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/cashouts-api/validate-bank-accounts/api-codes.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/platforms-booster/security-aspects.md)
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-reference/platforms-booster/security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Get submerchant information](https://apidocs.onekeypayments.com/api-reference/platforms-booster/get-submerchant-information.md)
- [Update a commission](https://apidocs.onekeypayments.com/api-reference/platforms-booster/update-a-commission.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/security-aspects.md)
- [Login](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/login.md)
- [Retrieve information](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information.md)
- [Get deposits](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-deposits.md)
- [Get cashouts](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-cashouts.md)
- [Get refunds](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-refunds.md)
- [Get chargebacks](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-chargebacks.md)
- [Get settlements](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-settlements.md)
- [Get notes](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-notes.md)
- [Get balance report](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-balance-report.md)
- [Get actual balance](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/retrieve-information/get-actual-balance.md)
- [Logout](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/logout.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/reconciliation-api/api-codes.md)
- [Security aspects](https://apidocs.onekeypayments.com/api-reference/know-your-customer-api/security-aspects.md)
- [Calculating the Signature](https://apidocs.onekeypayments.com/api-reference/know-your-customer-api/security-aspects/calculating-the-signature.md): Learn how to calculate and send the Signature header value to verify requests integrity
- [Get customer information](https://apidocs.onekeypayments.com/api-reference/know-your-customer-api/get-customer-information.md)
- [API Codes](https://apidocs.onekeypayments.com/api-reference/know-your-customer-api/get-customer-information/api-codes.md)
- [Countries specifications](https://apidocs.onekeypayments.com/api-reference/resources/countries-specifications.md): Learn how to validate the country's specific details
- [Deposits Java SDK](https://apidocs.onekeypayments.com/api-reference/resources/deposits-java-sdk.md)
- [Deposits PHP SDK](https://apidocs.onekeypayments.com/api-reference/resources/deposits-php-sdk.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://apidocs.onekeypayments.com/readme.md?ask=<question>
```
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.