# API Documentation - [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 --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.onekeypayments.com/api-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.