# Tap API Docs 1.0 Documentation

> Documentation for Tap API Docs 1.0

## Guides
- [Overview](https://developers.tap.company/docs/get-started.md)
- [Authentication](https://developers.tap.company/docs/authentication.md): A detailed overview of API integration, workflow, and usage examples for 3D Secure authentication with Tap Payments.
- [Recurring Payments](https://developers.tap.company/docs/recurring-payments.md): A Step-by-Step Documentation for Setting Up and Processing Recurring Payments
- [Benefit Pay Web SDK](https://developers.tap.company/docs/benefitpay-web-sdk.md): Integrating BenefitPay SDK in your web application
- [Checkout](https://developers.tap.company/docs/checkout.md)
- [Checkout Flutter SDK ](https://developers.tap.company/docs/checkout-sdk-flutter.md): A comprehensive Flutter SDK for integrating payment processing into your Flutter applications. This SDK provides a secure, user-friendly checkout experience with support for multiple payment methods, currencies, and customization options across both Android and iOS platforms.
- [Web Card SDK V2](https://developers.tap.company/docs/card-sdk-web-v2.md): Integrating Card SDK (V2) in Your Website
- [Apple Pay Web SDK](https://developers.tap.company/docs/apple-pay-web-sdk.md): Streamlining Secure Payments with Apple Pay Integration in a Web Environment
- [Samsung Pay](https://developers.tap.company/docs/samsung-pay-token.md): Streamlining Secure Payments with Samsung Pay Direct Integration
- [Cards](https://developers.tap.company/docs/cards.md)
- [Google Pay](https://developers.tap.company/docs/google-pay.md): Google Pay is a digital wallet platform and online payment system that allows users to store their credit and debit cards, and other payment methods in the app to make purchases online and in stores.
- [OmanNet](https://developers.tap.company/docs/omannet.md): Streamlining Secure Payments with OmanNet Integration
- [Benefit](https://developers.tap.company/docs/benefit.md): Streamlining Secure Payments with Benefit Integration
- [Apple Pay](https://developers.tap.company/docs/apple-pay.md): Apple Pay allows its customers a seamless payment experience with Apple devices, iOS and Safari browser.
- [Apple Pay CSR CER Process](https://developers.tap.company/docs/apple-pay-csr-cer.md): This document is dedicated to walk you through the steps you need to follow to configured the Apple Pay CSR/CER
- [Apple Pay (Decrypted Payload)](https://developers.tap.company/docs/apple-pay-decrypted-payload.md): This documentation provides instructions for making a payment using decrypted data obtained from an Apple Pay payload.
- [KNET](https://developers.tap.company/docs/knet.md): KNET is a Kuwaiti based domestic payment option, comes with debit cards.
- [KFAST](https://developers.tap.company/docs/kfast.md): KFAST is a card saving feature offered by KNET
- [NAPS/QPay](https://developers.tap.company/docs/qpay.md): Naps/Qpay is a local payment option in Qatar, usually debit cards.
- [STC Pay](https://developers.tap.company/docs/stcpay.md): STC Pay is a local payment option in KSA, which enables the customers to pay with their phone numbers registred in STC Pay
- [Tabby](https://developers.tap.company/docs/tabby.md): Integration Guide: Integrating Tabby via tap
- [Deema](https://developers.tap.company/docs/deema.md): Step-by-Step Guide for Merchants to Integrate Deema with Tap Payments
- [Tamara](https://developers.tap.company/docs/tamara.md): Integration Guide: Integrating Tamara via Tap
- [Woocommerce](https://developers.tap.company/docs/woocommerce.md): Simplifying Tap Payments Integration for Your WooCommerce Store
- [Magento](https://developers.tap.company/docs/magento.md): Simplifying Tap Payments Integration for Your Magento Store
- [Webhook](https://developers.tap.company/docs/webhook.md): Tap ensures secure and realtime webhooks for payment events, and to send the post payment details.
- [Getting Started](https://developers.tap.company/docs/marketplace-getting-started.md)
- [User Access Permissions](https://developers.tap.company/docs/user-access-permissions.md): Access Levels and Permissions for Super Admin, Admin, and Agent
- [Authorize and Capture](https://developers.tap.company/docs/authorize-and-capture.md): A Guide for Authorizing and Capturing Transactions
- [Recommendations & Best Practices](https://developers.tap.company/docs/recommendations-best-practices.md): Integration Recommendations & Best Practices
- [Encrypted Card Flow (PCI)](https://developers.tap.company/docs/encrypted-card-flow-pci.md)
- [Save Card Use Case Scenarios](https://developers.tap.company/docs/save-card-use-case-scenarios.md)
- [Idempotency in Payment Processing](https://developers.tap.company/docs/idempotency.md): Understanding the usage of idempotent string
- [Creating a Lead](https://developers.tap.company/docs/creating-a-lead.md)
- [Creating a Merchant Account](https://developers.tap.company/docs/creating-a-merchant-account.md)
- [Creating a Transaction](https://developers.tap.company/docs/creating-a-transaction.md)
- [Reports Download Concepts](https://developers.tap.company/docs/reports-concepts.md): This page describes how you can benefit from the download APIs to download customized reports(e.g., this month's payouts etc.)
- [Payout Report](https://developers.tap.company/docs/payout-report.md): Step-by-Step Guide to Accessing and Analyzing Payout Data
- [Reports for Commerce Platforms](https://developers.tap.company/docs/commerce-platform-reports.md): This article is dedicated to show merchant accounts under commerce platforms the ways they can generates different reports in tap payments
- [Overview of Acceptance SmartPOS](https://developers.tap.company/docs/overview-of-acceptance-smartpos.md): Accept Real-Time, Secure Payments on PAX Devices – Built for Kuwait Merchants & POS Platforms Providers
- [Acceptance SmartPOS for Merchants](https://developers.tap.company/docs/acceptance-smartpos-for-merchants.md): Accept Payments as a Merchant: Link Your Terminal with Acceptance SmartPOS
- [Terminal Registration on TapOS](https://developers.tap.company/docs/merchant-registration-onboarding.md)
- [Terminal Registration on Connect Board](https://developers.tap.company/docs/terminal-device-registration.md)
- [Acceptance SmartPOS for Platforms](https://developers.tap.company/docs/acceptance-smartpos-for-platforms.md): Integrate Acceptance SmartPOS for Your Platform and enable merchants to accept payments
- [Onboarding Merchants](https://developers.tap.company/docs/smartpos-onboarding-merchants.md)
- [Accepting Transactions](https://developers.tap.company/docs/accepting-transactions-platforms.md)
- [Webhooks & Notifications](https://developers.tap.company/docs/webhooks-notifications.md)
- [Error Handling & Testing](https://developers.tap.company/docs/error-handling-testing.md)
- [Onboarding Merchants](https://developers.tap.company/docs/smartpos-for-platforms.md)

## API Reference
- [Authorize](https://developers.tap.company/reference/authorize.md): This section will describe the Authorize API overview, the request and response example.
- [Create an Authorize](https://developers.tap.company/reference/create-an-authorize.md): This endpoint authorizes a transaction.
- [Update an Authorize](https://developers.tap.company/reference/update-an-authorize.md): This endpoint updates the required details for any specified authorized transactions.
- [Download Authorize](https://developers.tap.company/reference/download-authorize.md): This endpoint allows you to retrieve a list of authorizes with detailed information. The response returned can be saved in a CSV file. Each row represents an authorization with its respective details, and the first row contains the headers describing each field.
- [Charges](https://developers.tap.company/reference/charges.md): This section will describe the Charges API overview, the request and response example.
- [Create a Charge](https://developers.tap.company/reference/create-a-charge.md): This endpoint initiates a charge request to charge a credit card or any other payment source.
- [Update a Charge](https://developers.tap.company/reference/update-a-charge.md): This endpoint updates the required details for a specified charge.
- [List all Charges](https://developers.tap.company/reference/list-all-charges.md): This endpoint returns a list of all previously created charges, with the most recent charges appearing first.
- [Download Charges](https://developers.tap.company/reference/download-charges.md): This endpoint allows you to retrieve a list of charges with detailed information for each charge. The response returned can be saved in a CSV file. Each row represents a charge with its respective details, and the first row contains the headers describing each field.
- [Intents](https://developers.tap.company/reference/intents.md): This section will describe the Intents API overview, the request and response example.
- [Create an Intent](https://developers.tap.company/reference/create-an-intent.md): This endpoint initiates an intent request to create a POS-initiated transaction from the cash register, computer, or any point of sale device.
- [Retrieve an Intent](https://developers.tap.company/reference/retrieve-an-intent.md): This endpoint retrieves the details of an intent that was previously created.
- [List all Intents](https://developers.tap.company/reference/list-all-intents.md): This endpoint returns a list of all previously created intents, with the most recent intents appearing first.
- [Cancel an Intent](https://developers.tap.company/reference/cancel-an-intent.md): This endpoint is for cancelling an intent/POS-initiated transaction from the cash register, computer, or any point of sale device.
- [Refund](https://developers.tap.company/reference/refunds.md): Allows to control the refunds through API call
- [Create a Refund](https://developers.tap.company/reference/create-a-refund.md): Creating a refund request
- [Download Refunds](https://developers.tap.company/reference/download-refunds.md): This endpoint allows you to retrieve a list of refunds with detailed information for each refund. The response returned can be saved in a CSV file. Each row represents a refund with its respective details, and the first row contains the headers describing each field.
- [Create a Token (Card)](https://developers.tap.company/reference/create-a-token.md): This endpoint creates a single-use token that securely contains the details of a credit card.
- [Create a Token (Encrypted Card)](https://developers.tap.company/reference/create-a-token-encrypted-card.md): This endpoint creates a token to securely store sensitive card information.
- [Create a Token (Saved Card)](https://developers.tap.company/reference/create-a-token-from-saved-card.md): This endpoint creates a token using a saved card id, but this requires a Card ID and Customer ID.
- [Create a Token (Apple Pay token)](https://developers.tap.company/reference/create-applepay-tap-token.md): Merchants can create the Token ID by passing the Apple Pay encrypted payment token, which is obtained directly from Apple Pay
- [Create a Token (Samsungpay token)](https://developers.tap.company/reference/create-samsungpay-token.md): Merchants can create the Token ID by passing the Samsung Pay encrypted payment token, which is obtained directly from Samsung Pay
- [Create a Token (Network Token)](https://developers.tap.company/reference/create-a-token-network-token.md): This endpoint creates a single-use Network token that securely contains the details of a card.
- [Cards](https://developers.tap.company/reference/cards-2.md): This section will describe the Card API overview, the request and response example.
- [Retrieve a Card](https://developers.tap.company/reference/retrieve-a-card.md): This endpoint can be used to retrieve details of cards saved under a customer. The 10 most recent cards directly linked to a customer or recipient are always visible
- [Verify a Card](https://developers.tap.company/reference/verify-a-card.md): This endpoint validates credit cards and returns a response of either 'Valid' or 'Invalid.' It's intended for those who want to save cards for recurring payments. By validating the card, merchants can ensure that they only save valid cards. Additionally, the merchant can save the card in a single step by passing 'save_card = true'.  There are three possible responses:  INITIATED: Tap provides a payment URL (transaction.url) to initiate verification. The customer should be redirected to this URL to complete the verification; VALID: The card is valid; INVALID: The card is invalid.
- [Delete a Card](https://developers.tap.company/reference/delete-a-card.md): This endpoint can be used to delete any saved cards.
- [List All Cards](https://developers.tap.company/reference/list-all-cards.md): This endpoint can be used to see a list of all the saved cards. The object always displays the 10 most recent sources. To view additional saved cards beyond the default 10, use the API with the 'limit' and 'starting_after' parameters.
- [Create an Invoice](https://developers.tap.company/reference/create-an-invoice.md)
- [Update an Invoice](https://developers.tap.company/reference/update-an-invoice.md)
- [List all Invoices](https://developers.tap.company/reference/list-all-invoices.md)
- [Payout](https://developers.tap.company/reference/payout.md): This page will help you get started with payouts.
- [Retrieve a Payout](https://developers.tap.company/reference/retrieve-a-payout.md): This endpoint allows you to retrieve details about a single payout based on its payout ID.
- [List All Payouts](https://developers.tap.company/reference/list-payouts.md): This endpoint returns a list of all previous payouts, with the most recent payouts appearing first.
- [Download Payouts](https://developers.tap.company/reference/download-payouts.md): This endpoint allows you to download the payouts with detailed information for each payout. The response returned is a zip file contains all the details of the payout such as the charges, refunds, payout summary, dispute and released dispute. Here is an example of the [folder](https://drive.google.com/drive/folders/1D5YTG5ZucN8urWquzbh7rtEt3IeoLWgi?usp=sharing).
- [Lead](https://developers.tap.company/reference/lead.md): The section will describe the lead API overview, request and response model.
- [Create a Lead (Merchant)](https://developers.tap.company/reference/create-a-lead-v3.md): This is version 3 endpoint to create a lead and the newest. Use this key to call this API with success response sk_test_qdiChYK2reTf4AByvS8Wkx9H
- [Retrieve a Lead](https://developers.tap.company/reference/retrieve-a-lead.md): This endpoint retrieves the details of a lead that was previously created.
- [Create lead for retailer](https://developers.tap.company/reference/create-a-lead-for-retailer.md)
- [Update Lead](https://developers.tap.company/reference/update-a-lead-for-retailer.md)
- [Create an Account (Retailer)](https://developers.tap.company/reference/convert-lead-to-a-retailer.md): After creating a lead ID for a Retailer you need to use this API to convert the lead to a Retailer account and get the retailer.id
- [Business](https://developers.tap.company/reference/business.md): This section will describe the Business API overview, the request and response example.
- [Create a Business](https://developers.tap.company/reference/create-a-business.md): This endpoint allows you to create a business.
- [List All Businesses](https://developers.tap.company/reference/list-all-businesses.md): This endpoint lists all business under a marketplace.
- [Destinations](https://developers.tap.company/reference/destinations.md)
- [Retrieve a Destination](https://developers.tap.company/reference/retrieve-a-destination.md): This endpoint can be used to retrieve a destination.
- [List All Destinations](https://developers.tap.company/reference/list-all-destinations.md): This endpoint can be used to list all destinations.
- [Create a Merchant](https://developers.tap.company/reference/create-a-merchant.md): This endpoint creates a merchant linked to your business.
- [List All Merchants](https://developers.tap.company/reference/list-all-merchants.md): This endpoint lists all merchants.
- [Create a Customer](https://developers.tap.company/reference/create-a-customer.md)
- [Retrieve a Customer ](https://developers.tap.company/reference/retrieve-a-customer.md): Retrieve the Customer details
- [Update a Customer ](https://developers.tap.company/reference/update-a-customer.md)
- [List All Customers](https://developers.tap.company/reference/customer-list.md): Retreive all the customers created using the API key
- [Files](https://developers.tap.company/reference/files.md): The section will describe the file API overview, request model, and response model.
- [Create a File](https://developers.tap.company/reference/create-a-file.md): This endpoint creates a file.
- [Payout Webhook and Download API](https://developers.tap.company/reference/webhook-api.md)
- [Test Cards Numbers](https://developers.tap.company/reference/testing-cards.md)
- [Charges Response Codes](https://developers.tap.company/reference/charge-response-codes.md)
- [Getting Started With Your API](https://developers.tap.company/reference/getting-started-with-your-api-7.md): This page will help you get started with BIN.
- [Download Disputes](https://developers.tap.company/reference/download-disputes.md): This endpoint allows you to retrieve a list of disputes with detailed information for each dispute. The response returned can be saved in a CSV file.
- [Getting Started With Your API](https://developers.tap.company/reference/getting-started-with-your-api-17.md): This page will help you get started with Tokens (Encrypted Card).
- [Create a Connect URL](https://developers.tap.company/reference/create-a-connect-url.md): This endpoint converts a lead into a connect URL which the merchant can complete the onboarding process.