# Pockyt Documentation

> Documentation for Pockyt

## Guides
- [Overview](https://docs.pockyt.io/docs/overview.md)
- [Integration Guide Manual](https://docs.pockyt.io/docs/integration-guide-manual.md)
- [Off-Ramp with Pockyt](https://docs.pockyt.io/docs/ramp-off-with-pockyt.md): Convert USDC to Fiat and Pay Out Seamlessly
- [On-Ramp with Pockyt](https://docs.pockyt.io/docs/ramp-on-with-pockyt.md): Convert Fiat to USDC and Pay Out Seamlessly
- [Direct Merchant vs. Merchant of Record (MoR) Payouts](https://docs.pockyt.io/docs/direct-merchant-vs-merchant-of-record-mor-payouts.md)
- [Pockyt Credit Card Payments w/ Capture 3DS](https://docs.pockyt.io/docs/pockyt-credit-card-payment-w-capture-3ds.md)
- [Pockyt Hosted Checkout Page w/ SecurePay](https://docs.pockyt.io/docs/pockyt-hosted-checkout-page-w-securepay.md)
- [Recurring Payments via SecurePay API (vaulting)](https://docs.pockyt.io/docs/pockyt-hosted-checkout-page.md): This guide outlines the steps to implement a recurring payments solution using Pockyt’s SecurePay API. This workflow enables merchants to manage repeated transactions.
- [In-Store Payments w/ SecurePay](https://docs.pockyt.io/docs/in-store-payments-w-securepay.md): This guide outlines the process of integrating the SecurePay API with in-store POS systems to enable secure, QR code-based payment processing via PayPal.
- [Recurring Payments via the Capture API](https://docs.pockyt.io/docs/recurring-payments-via-the-capture-api.md): This guide details integration with our payment and payout API suite using the Capture API for processing transactions, including hosted, recurring, and direct payouts.
- [Customer presents QRC](https://docs.pockyt.io/docs/customer-presents-qrc.md)
- [Merchant Presents QRC](https://docs.pockyt.io/docs/merchant-presents-qrc.md): This guide outlines the process of integrating the Merchant Presents QRC workflow to enable secure, QR code-based payment processing. By following these steps, developers can streamline customer transactions, improve payment efficiency, and ensure robust handling of API, QR code generation, and webhook notifications.
- [Merchant Presents Mixed QRC](https://docs.pockyt.io/docs/merchant-presents-mixed-qrc.md): This guide outlines the process of integrating the Merchant Presents QRC workflow to enable secure, QR code-based payment processing.
- [Refund Payments](https://docs.pockyt.io/docs/refund-payments.md): Learn how to integrate the SecurePay API refund functionality with in-store POS systems for secure payment refund processing.
- [Payouts to Chinese Bank Accounts](https://docs.pockyt.io/docs/payouts-to-chinese-bank-accounts.md): This guide details a step-by-step implementation of payouts to Chinese bank accounts via the non-Pockyt wallet configuration.
- [Payouts to Bank Accounts](https://docs.pockyt.io/docs/payouts-to-bank-accounts.md): This guide details a step-by-step implementation of payouts to bank accounts in USD.
- [Payouts to Paypal wallet](https://docs.pockyt.io/docs/payouts-to-paypal-wallet.md): This guide details a step-by-step implementation of payouts using the Paypal Wallet.
- [Crypto Payouts](https://docs.pockyt.io/docs/payouts-through-crypto.md): This guide details a step-by-step implementation of Crypto Payouts.
- [Payouts Workflow: Pockyt User](https://docs.pockyt.io/docs/payout-workflow-pockyt-user.md): This workflow describes how to initiate a payout to
- [Merchant of Record Payout Workflow](https://docs.pockyt.io/docs/merchant-of-record-payout-workflow.md): Merchant of Record (MoR) executes payouts to bank accounts on behalf of a Payor (sub-merchant)
- [Partner Onboards Merchants](https://docs.pockyt.io/docs/partner-onboards-merchants.md): Choose Your Onboarding Path: Integrate via API, Use the Portal, or Share a Link
- [Merchant Onboarding API](https://docs.pockyt.io/docs/merchant-onboarding-api.md): Pockyt's Merchant Onboarding API enables partners to authenticate, submit, and track merchant applications efficiently via four core endpoints.
- [Payor Onboarding API](https://docs.pockyt.io/docs/payor-onboarding-api.md): Onboarding Payors (sub-merchants) programmatically using the Pockyt API.
- [MCP](https://docs.pockyt.io/docs/mcp.md)
- [What info is required for a Payee?](https://docs.pockyt.io/docs/what-info-is-required-for-a-payee.md): Required info to register a payee depending on user type.
- [How to Simulate Different Card Transaction Scenarios](https://docs.pockyt.io/docs/how-to-simulate-different-card-transaction-scenarios.md): Simulate different card

## API Reference
- [Introduction](https://docs.pockyt.io/reference/introduction-to-pockyts-apis-copy.md)
- [Authentication](https://docs.pockyt.io/reference/authentication.md)
- [Error Codes](https://docs.pockyt.io/reference/status-error-codes.md)
- [Introduction To Pockyt's APIs](https://docs.pockyt.io/reference/about.md): Learn about the structure and organization of the API Reference Section in our developer documentation
- [Checkout APIs](https://docs.pockyt.io/reference/checkout-apis.md): The Checkout APIs power Pockyt's online payment acceptance. Use these endpoints to register customers, initiate payments, query transaction history, process refunds, and check merchant balances.
- [In-Store APIs](https://docs.pockyt.io/reference/in-store-apis-1.md): Enable point-of-sale (POS) payment acceptance through QR code-based workflows. Use these endpoints to create transactions, process payments, and manage QR codes for physical retail environments.
- [Payout APIs](https://docs.pockyt.io/reference/payout-apis.md): Handle disbursements — sending funds from your Pockyt merchant account to payees. Use these endpoints to register payees, set up their funding accounts, execute payouts, and manage the associated resources.
- [Internal Transfer APIs](https://docs.pockyt.io/reference/internal-transfer-apis.md): Enable book transfers between virtual accounts within the Pockyt platform. Use these endpoints to move funds between accounts you manage — no external bank accounts or payment methods are involved.
- [Webhook Notification Reference](https://docs.pockyt.io/reference/webhook-notification-reference.md): A reference guide for webhook event payloads and their parameters.
- [Idempotency Key in Pockyt](https://docs.pockyt.io/reference/idempotency-key-in-pockyt-api.md)
- [Available Payment Methods](https://docs.pockyt.io/reference/available-payment-methods.md): This page outlines the currently supported payment methods for both Checkout and PayOuts, including consumer regions and transaction currencies.
- [Online Payments](https://docs.pockyt.io/reference/hosted-payments.md): Pockyt's online payment solution enables merchants to accept payments through digital wallets, credit cards, and alternative payment methods via API.
- [Register Customer](https://docs.pockyt.io/reference/register-customer.md): The endpoint generates new customer profiles. The response includes a customerNo, which is used to reference the customer in other endpoints such as SecurePay and features such as recurring payments.
- [Retrieve Customer Info](https://docs.pockyt.io/reference/customer-retrieve-customer.md): This endpoint allows you to fetch customer information stored in the record.
- [SecurePay API](https://docs.pockyt.io/reference/securepay-api.md): This endpoint is used to generate payment links/QR codes directing customers to Pockyt's hosted page to receive payments.
- [Capture](https://docs.pockyt.io/reference/capture.md): This endpoint sends credit card information directly to Pockyt to process a transaction.
- [Process API](https://docs.pockyt.io/reference/process-api.md): This endpoint is used following a transaction initiation from the Capture endpoint to complete the payment and receive a vaultId (identifier for the stored payment details).
- [Micro-PrePay API](https://docs.pockyt.io/reference/securepay-api-copy.md): This endpoint enables mobile payments specifically tailored for WeChat In-App solutions
- [Customer presents QRC](https://docs.pockyt.io/reference/in-store-apis.md)
- [Create New Transaction](https://docs.pockyt.io/reference/add-transaction-api.md): This API enables the merchant's POS system to generate a distinct transaction number, which will play a crucial role after the customer presents their payment barcode. This transaction number gets linked to the payment, and the merchant POS system can also assign its own reference number, which will be associated with the transaction number generated by Pockyt. This reference number can be used later for inquiries and reporting purposes. In essence, it facilitates the creation of a transaction object and provides customers with a transaction number to initiate their payments.
- [Process Payment](https://docs.pockyt.io/reference/pay-transaction-api.md): This API serves as a means for the Merchant's POS system to verify and execute payments via digital wallet networks. To do so, the Merchant's POS must transmit both the transaction number obtained from the prior "/add" API call and the payment barcode value generated when the customer scans their digital wallet.
- [Cancel Payment](https://docs.pockyt.io/reference/cancel-api.md): This API enables the Merchant's POS system to trigger a cancellation notification for a transaction, especially when a customer abandons the process or when the cashier needs to initiate a cancellation instruction after the initial transaction number has been generated. Its primary purpose is to facilitate the cancellation of payment transactions in cases where the transaction is abandoned before final submission.
- [Create QR Code](https://docs.pockyt.io/reference/create-qrc-api.md): This API allows merchant POS systems to generate QR codes with unique transaction numbers from the Pockyt system. When customers scan these QR codes using their mobile digital wallet apps, they can access payment URLs, transaction numbers, and transaction details sent by the Merchant POS system. Essentially, it simplifies the process of creating QR codes and transaction numbers for customers to initiate payments through their digital wallet apps.
- [Generate Mixed QR Code](https://docs.pockyt.io/reference/generate-mixed-qrcode.md): This endpoint is used to generate a mixed payment QR code. The response includes a QR code URL and a redirect URL for the payment page.
- [Query Mixed QR Code Transaction](https://docs.pockyt.io/reference/mixed-qrcode-query.md): This endpoint is used to query the status of a mixed QR code transaction. Either "recordNo" or "reference" can be used to identify the transaction.
- [Cancel Mixed QR Code Transaction](https://docs.pockyt.io/reference/mixed-qrcode-cancel.md): This endpoint is used to cancel a mixed QR code transaction. Either "recordNo" or "reference" can be used to identify the transaction.
- [Queries and Reporting](https://docs.pockyt.io/reference/refund-and-query-apis.md): Describes the Queries and Reporting endpoints and workflow.
- [Query Specific Transactions](https://docs.pockyt.io/reference/query-api.md): This endpoint allows you to query a specific transaction.
- [Add Notes to Transaction](https://docs.pockyt.io/reference/query-specific-transactions-copy.md): This endpoint allows you to add notes and supplementary data to transaction records.
- [Query Bulk Transactions](https://docs.pockyt.io/reference/notes-api-copy.md): This endpoint allows you to query transactions in bulk.
- [Refund](https://docs.pockyt.io/reference/refund-and-cancel.md): Process full or partial refunds for completed checkout transactions.
- [Refund API](https://docs.pockyt.io/reference/refund-api.md): To allow the customer to request a refund, the following request and response objects are initiated to complete the refund workflow.
- [Balance](https://docs.pockyt.io/reference/balance-1.md): Query your real-time merchant settlement balance, including available funds, pending transactions, and reserve amounts.
- [Retrieve Merchant Balance](https://docs.pockyt.io/reference/retrieve-merchant-balance.md): This endpoint returns the current balance details for a merchant's account, including available balance, pending balance, rolling reserve balance, and freeze reserve balance.
- [Register Payee](https://docs.pockyt.io/reference/payouts-register-payee.md): This endpoint is used to register a new payee. The response includes a customerNo used to refer to the registered payee for future transactions. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Deactivate payee](https://docs.pockyt.io/reference/deactivate-payee.md): Update payee status to deactivate
- [Delete Payee](https://docs.pockyt.io/reference/register-payee-copy.md): This endpoint is used to delete a payee associated with the customerNo provided.
- [Retrieve Payee](https://docs.pockyt.io/reference/payouts-retrieve-payee.md): This endpoint is used to retrieve information about a specific registered payee using their customerNo. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Update Payee](https://docs.pockyt.io/reference/payouts-update-payee.md): This endpoint is used to update details on a payee's account. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. For MoR integrations: email cannot be modified (existing restriction), payorNo cannot be modified (PC-1092 new restriction), and name modification is subject to merchant configuration restrictions.
- [Get Account Requirements](https://docs.pockyt.io/reference/international-transfer-methods.md): This endpoint is used to retrieve the configuration parameters for available payment methods in international transfers and crypto accounts. On the right-hand side, in the cURL section, you'll find examples showing how the request would look depending on whether you're using bank accounts or a crypto wallet.
- [Create Funding Account](https://docs.pockyt.io/reference/payouts-add-payee-bank.md): This endpoint allows you to create a funding account linked to a payee. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Add Payee PayPal Funding Method](https://docs.pockyt.io/reference/add-payee-funding-method-copy.md): This endpoint allows you to create a Paypal funding account linked to a payee. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Add Payee Venmo Funding Account](https://docs.pockyt.io/reference/add-payee-venmo-funding-account.md): This endpoint allows you to create a Venmo funding account linked to a payee. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Add a Cryptocurrency Wallet Funding Method](https://docs.pockyt.io/reference/add-a-cryptocurrency-wallet-funding-method.md): Link a crypto wallet to a payee’s account for funding transactions. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Retrieve Funding Accounts](https://docs.pockyt.io/reference/payouts-retrieve-payee-funding-accounts.md): This endpoint returns a list of all funding sources linked to a payee's account. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Delete Funding Account](https://docs.pockyt.io/reference/payouts-delete-payee-funding-account.md): This endpoint removes the funding account from a payee's profile associated with the account's unique identifier. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. For MoR integrations, the system validates the Payor status before deletion: if the account's Payor status is DECLINED, deletion is rejected; if the account's Payor status is SAVED (not activated), deletion is also rejected.
- [Initiate Payout](https://docs.pockyt.io/reference/payouts-transfer-payout.md): This endpoint triggers the transfer of the specified funds to the payee's account. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. For MoR integrations, the system processes the payout according to the account's Payor configuration. The response structure remains the same for both flows.
- [Inquire Payout Details](https://docs.pockyt.io/reference/register-payee-copy-1.md): This endpoint is used to obtain details about an specific payout transaction. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.
- [Upload Payout Invoice](https://docs.pockyt.io/reference/payouts-upload-payout-invoice.md): This endpoint is used to upload payout invoice files using multipart/form-data. This endpoint is specific to Merchant of Record (MoR) integrations and supports the V2 invoice upload format. Maximum file size is 10 MB. Supported file types: jpg, jpeg, png, pdf. Maximum 10 invoice files per transactionNo.
- [Retrieve Merchant Balance](https://docs.pockyt.io/reference/payouts-retrieve-payor-balance.md): This endpoint returns the current funds available in a merchant's account.
- [Check FX Rate](https://docs.pockyt.io/reference/payouts-check-fx-rate.md): Check current foreign exchange rates by hitting this endpoint. It is particularly useful for international payouts where currency conversion is necessary.
- [Initiate Internal Transfer](https://docs.pockyt.io/reference/transfer-internal.md): This endpoint is used to initiate an internal book transfer between two accounts within the Pockyt system. Funds are moved from the source account to the destination account in real time.
- [Inquire Internal Transfer](https://docs.pockyt.io/reference/transfer-inquiry.md): This endpoint is used to retrieve the details of a previously initiated internal transfer. You can look up a transfer using either the invoiceId or the transactionNo — at least one must be provided.
- [Deposit Notifications](https://docs.pockyt.io/reference/deposit-notifications.md): Receive real-time notifications when funds arrive in or are returned from your virtual account.
- [Merchant Onboarding](https://docs.pockyt.io/reference/merchant-onboarding-guide.md): This page will help you get started with Merchant Onboarding API.
- [Merchant Onboarding API Base URL](https://docs.pockyt.io/reference/getting-started-with-your-api-1.md): This page will help you get started with Merchant Onboarding API.
- [Get Token](https://docs.pockyt.io/reference/get-token.md): This endpoint is used to get the bearer token used for authentication in the submit and query endpoints.
- [Submit Merchant Application](https://docs.pockyt.io/reference/submit-merchant-application.md): The "Submit" endpoint is the primary interface for submitting merchant applications to Pockyt Payments. This endpoint is utilized by partners to send comprehensive merchant information for processing and approval.
- [Query Merchant Application](https://docs.pockyt.io/reference/query-merchant-application.md): This API allows users to retrieve detailed information about a merchant's application, including status, business, banking, and ownership details.
- [Upload Merchant Onboarding Document](https://docs.pockyt.io/reference/upload-merchant-onboarding-document.md): Uploads a supporting document for an existing merchant onboarding application. Use this endpoint after a merchant application has been created and a merchant number is available.
- [Additional Parameter References](https://docs.pockyt.io/reference/additional-references.md)
- [Payor Onboarding](https://docs.pockyt.io/reference/payor-onboarding.md): This page will help you get started with Payor Onboarding API.
- [Register Payor](https://docs.pockyt.io/reference/payor-register.md): This endpoint is used to register a new Payor (sub-merchant) under a Merchant of Record (MoR) account. The response includes a payorNo used to refer to the registered Payor for future operations such as document uploads, payee registration, and payouts.
- [Upload Payor Document](https://docs.pockyt.io/reference/payor-upload-document.md): This endpoint is used to upload supporting documents (such as business licenses, identification documents, bank statements, etc.) for a registered Payor. Authentication parameters and file metadata are passed as query parameters, while the file itself is sent as multipart/form-data in the request body. Each Payor can upload up to 20 files per document type.
- [Retrieve Payor Detail](https://docs.pockyt.io/reference/payor-retrieve-detail.md): This endpoint is used to query the status and basic information of a Payor application. Merchants of Record (MoR) can use this endpoint to check the current underwriting status, creation time, and submission time of their Payors.