# MyFatoorah API Documentation > MyFatoorah Main API & E-commerce Plugins ## Guides - [Get Started](https://docs.myfatoorah.com/docs/get-started.md): Build your integration and start accepting payments online - [Live Account](https://docs.myfatoorah.com/docs/live-account.md): How to create your account with MyFatoorah? - [Account Information](https://docs.myfatoorah.com/docs/account-information.md) - [Orders Information](https://docs.myfatoorah.com/docs/orders-information.md) - [API Key](https://docs.myfatoorah.com/docs/api-key.md) - [Test Cards](https://docs.myfatoorah.com/docs/test-cards.md): Payment Gateways Test Cards Details - [ISO Lookups](https://docs.myfatoorah.com/docs/iso-lookups.md) - [Choose Your Payment Integration](https://docs.myfatoorah.com/docs/choose-your-payment-integration.md) - [Embedded Payment](https://docs.myfatoorah.com/docs/embedded-payment-v3.md) - [Customizing Embedded Payment](https://docs.myfatoorah.com/docs/customizing-embedded-payment.md) - [Tokenized Embedded Payments](https://docs.myfatoorah.com/docs/v3-token-payments.md) - [Sample Code ](https://docs.myfatoorah.com/docs/embedded-payment-sample-code-1.md): Embedded Payment Sample Code - [Hosted Payment Page](https://docs.myfatoorah.com/docs/v3-hosted-payment-page.md) - [Invoicing](https://docs.myfatoorah.com/docs/v3-invoicing.md) - [Direct Payment](https://docs.myfatoorah.com/docs/v3-direct-payment.md) - [Card Direct Integration](https://docs.myfatoorah.com/docs/card-direct-integration.md) - [Apple Pay Direct Integration](https://docs.myfatoorah.com/docs/v3-apple-pay-direct-integration.md) - [Samsung Pay Direct Integration](https://docs.myfatoorah.com/docs/v3-samsung-pay-direct-integration.md) - [Features](https://docs.myfatoorah.com/docs/features.md) - [Get Payment Details](https://docs.myfatoorah.com/docs/get-payment-details.md) - [Updating Payment Status Guidelines](https://docs.myfatoorah.com/docs/v3-updating-payment-status-guidelines.md) - [Saving Card Options](https://docs.myfatoorah.com/docs/v3-saving-card-options.md) - [Embedded Payment](https://docs.myfatoorah.com/docs/v3-saving-card-embedded-payment.md): Save the payment card with the embedded payment - [Direct Payment Tokenization](https://docs.myfatoorah.com/docs/v3-direct-tokenization.md) - [KFast Payment](https://docs.myfatoorah.com/docs/kfast.md) - [Refund](https://docs.myfatoorah.com/docs/refund.md): Make a refund request - [MakeRefund](https://docs.myfatoorah.com/docs/make-refund.md): Endpoint - [GetRefundStatus](https://docs.myfatoorah.com/docs/getrefundstatus.md): Endpoint - [Sample Code](https://docs.myfatoorah.com/docs/refund-sample-code.md) - [Multi-Vendors](https://docs.myfatoorah.com/docs/multiple-suppliers.md): Multiple Suppliers - [Supplier Information](https://docs.myfatoorah.com/docs/supplier-information.md) - [CreateSupplier](https://docs.myfatoorah.com/docs/create-supplier.md): Endpoint - [EditSupplier](https://docs.myfatoorah.com/docs/edit-supplier.md): Endpoint - [CustomizeSupplierCommissions](https://docs.myfatoorah.com/docs/customizesuppliercommissions.md): Endpoint - [Amount Distribution with Suppliers](https://docs.myfatoorah.com/docs/amount-distribution.md): Describes how much the suppliers, the vendor, and MyFatoorah take from the invoice. - [GetSuppliers](https://docs.myfatoorah.com/docs/get-suppliers.md): Endpoint - [GetSupplierDetails](https://docs.myfatoorah.com/docs/getsupplierdetails.md): Endpoint - [GetSupplierDeposits](https://docs.myfatoorah.com/docs/get-supplier-deposits.md): Endpoint - [GetSupplierDocuments](https://docs.myfatoorah.com/docs/get-supplier-documents.md): Endpoint - [GetSupplierDashboard](https://docs.myfatoorah.com/docs/get-supplier-dashboard.md): Endpoint - [UploadSupplierDocument](https://docs.myfatoorah.com/docs/upload-supplier-document.md): Endpoint - [MakeSupplierRefund](https://docs.myfatoorah.com/docs/make-supplier-refund.md): Endpoint - [TransferBalance](https://docs.myfatoorah.com/docs/transferbalance.md): Endpoint - [Authorize & Capture](https://docs.myfatoorah.com/docs/v3-auth-capture.md): Capturing/Releasing Amounts - [Card Verification](https://docs.myfatoorah.com/docs/card-verification.md) - [Recurring Payment](https://docs.myfatoorah.com/docs/recurring-payment.md): Execute Payments automatically - [GetRecurringPayment](https://docs.myfatoorah.com/docs/getrecurringpayment.md): Endpoint - [CancelRecurringPayment](https://docs.myfatoorah.com/docs/cancelrecurringpayment.md): Endpoint - [ResumeRecurringPayment](https://docs.myfatoorah.com/docs/resumerecurringpayment.md): Endpoint - [Sample Code](https://docs.myfatoorah.com/docs/recurring-payment-sample-code.md): Recurring - [Vendor-Managed Recurring](https://docs.myfatoorah.com/docs/v3-vendor-managed-recurring.md): Manage the recurring deductions from your side - [Merchant Initiated Transaction (MIT)](https://docs.myfatoorah.com/docs/merchant-initiated-transaction.md) - [Bypass 3DS](https://docs.myfatoorah.com/docs/bypass3ds.md) - [Shipping](https://docs.myfatoorah.com/docs/shipping.md): Create Shipping Invoice - [Shipping Information](https://docs.myfatoorah.com/docs/shipping-information.md) - [GetCountries](https://docs.myfatoorah.com/docs/get-countries.md): Endpoint - [GetCities](https://docs.myfatoorah.com/docs/get-cities.md): Endpoint - [CalculateShippingCharge](https://docs.myfatoorah.com/docs/calculate-shipping-charge.md): Endpoint - [UpdateShippingStatus](https://docs.myfatoorah.com/docs/update-shipping-status.md): Endpoint - [RequestPickup](https://docs.myfatoorah.com/docs/request-pickup.md): Endpoint - [GetShippingOrderList](https://docs.myfatoorah.com/docs/get-shipping-order-list.md): Endpoint - [Sample Code](https://docs.myfatoorah.com/docs/shipping-sample-code.md): Shipping - [Reporting](https://docs.myfatoorah.com/docs/reporting.md) - [GetDepositedInvoices](https://docs.myfatoorah.com/docs/getinvoicesbydepositreference.md): Endpoint - [Webhook](https://docs.myfatoorah.com/docs/webhook.md) - [Webhook Information](https://docs.myfatoorah.com/docs/webhook-information.md) - [Webhook Signature](https://docs.myfatoorah.com/docs/webhook-signature.md) - [Webhook V2](https://docs.myfatoorah.com/docs/webhook-v2.md) - [Payment Status Data Model](https://docs.myfatoorah.com/docs/webhook-v2-payment-status-data-model.md): Data Model - [Refund Data Model](https://docs.myfatoorah.com/docs/webhook-v2-refund-data-model.md): Data Model - [Balance Transferred Data Model](https://docs.myfatoorah.com/docs/webhook-v2-balance-transferred-data-model.md): Data Model - [Supplier Data Model](https://docs.myfatoorah.com/docs/webhook-v2-supplier-data-model.md): Data Model - [Recurring Data Model](https://docs.myfatoorah.com/docs/webhook-v2-recurring-data-model.md): Data Model - [Dispute Data Model](https://docs.myfatoorah.com/docs/webhook-v2-dispute-data-model.md): Data Model - [Supplier Update Request Data Model](https://docs.myfatoorah.com/docs/webhook-v2-supplier-update-request-data-model.md): Data Model - [GetWebhooks](https://docs.myfatoorah.com/docs/getwebhooks.md) - [Response Model](https://docs.myfatoorah.com/docs/response-model.md) - [Idempotency](https://docs.myfatoorah.com/docs/idempotency.md) - [Overview](https://docs.myfatoorah.com/docs/toolkit-overview.md): Useful Toolkit - [PHP Library](https://docs.myfatoorah.com/docs/php-library.md): Current Version: 2.2 - [Overview](https://docs.myfatoorah.com/docs/sdk-overview.md): Mobile app integration - [iOS SDK](https://docs.myfatoorah.com/docs/sdk-guide.md): SDK Guide for iOS - [Android SDK](https://docs.myfatoorah.com/docs/android-sdk.md): SDK Guide for Android - [Flutter](https://docs.myfatoorah.com/docs/flutter.md): Guide for Flutter - [React Native](https://docs.myfatoorah.com/docs/react-native.md): Guide for React Native - [Cordova](https://docs.myfatoorah.com/docs/cordova.md): Guide for Cordova - [Overview](https://docs.myfatoorah.com/docs/plugin-overview.md): Plugins and Addons - [Plugin API Permissions](https://docs.myfatoorah.com/docs/plugin-api-permissions.md) - [CS-Cart](https://docs.myfatoorah.com/docs/cs-cart.md) - [Webhook](https://docs.myfatoorah.com/docs/cs-cart-webhook.md) - [Embedded Apple Pay](https://docs.myfatoorah.com/docs/cs-cart-embedded-apple-pay.md): Cs-Cart - [Drupal Commerce](https://docs.myfatoorah.com/docs/drupalcommerce.md) - [Ecwid](https://docs.myfatoorah.com/docs/ecwid.md): Plugin - [Webhook](https://docs.myfatoorah.com/docs/ecwid-webhook.md): Ecwid - [ExpandCart](https://docs.myfatoorah.com/docs/expandcart.md) - [GoDaddy](https://docs.myfatoorah.com/docs/godaddy.md) - [Webhook](https://docs.myfatoorah.com/docs/godaddy-webhook.md): GoDaddy - [Joomla 3.x](https://docs.myfatoorah.com/docs/joomla-3x.md) - [Laravel](https://docs.myfatoorah.com/docs/laravel.md): 2.2.4 - [Magento2](https://docs.myfatoorah.com/docs/magento2.md) - [Shipping](https://docs.myfatoorah.com/docs/magento2-shipping.md): Magento2 - [Webhook](https://docs.myfatoorah.com/docs/magento2-webhook.md) - [Embedded Apple Pay](https://docs.myfatoorah.com/docs/magento2-embedded-apple-pay.md): Magento2 - [nopCommerce](https://docs.myfatoorah.com/docs/nopcommerce.md) - [Odoo](https://docs.myfatoorah.com/docs/odoo.md) - [Omnipay](https://docs.myfatoorah.com/docs/omnipay.md) - [OpenCart](https://docs.myfatoorah.com/docs/opencart.md) - [Shipping](https://docs.myfatoorah.com/docs/opencart-shipping.md): OpenCart - [Webhook](https://docs.myfatoorah.com/docs/opencart-webhook.md) - [Embedded Apple Pay](https://docs.myfatoorah.com/docs/opencart-embedded-apple-pay.md): OpenCart - [PrestaShop](https://docs.myfatoorah.com/docs/prestashop.md) - [Webhook](https://docs.myfatoorah.com/docs/prestashop-webhook.md) - [Shopify](https://docs.myfatoorah.com/docs/shopify.md): Installation Steps - [Shopify (Direct)](https://docs.myfatoorah.com/docs/shopify-direct.md): Installation Steps - [Symfony (New)](https://docs.myfatoorah.com/docs/symfony.md) - [Whautomate](https://docs.myfatoorah.com/docs/whautomate.md) - [WHMCS](https://docs.myfatoorah.com/docs/whmcs.md) - [Webhook](https://docs.myfatoorah.com/docs/whmcs-webhook.md): WHMCS - [WooCommerce](https://docs.myfatoorah.com/docs/woocommerce.md) - [Shipping](https://docs.myfatoorah.com/docs/woocommerce-shipping.md): WooCommerce - [Webhook](https://docs.myfatoorah.com/docs/woocommerce-webhook.md) - [Embedded Apple Pay](https://docs.myfatoorah.com/docs/woo-embedded-apple-pay.md): WooCommerce - [Zoho (New)](https://docs.myfatoorah.com/docs/zoho.md) ## API Reference - [Create Payment](https://docs.myfatoorah.com/reference/create-payment.md) - [Get Payment Details](https://docs.myfatoorah.com/reference/get-payment-details.md): Get the details of a payment by its paymentId. - [Update Payment (Capture or Release)](https://docs.myfatoorah.com/reference/update-payment.md): Used in the Auth & Capture flow to capture full/partial amount or release the authorized amount back to the customer. Only one Capture or Release operation is allowed for each invoice. - [Create Session](https://docs.myfatoorah.com/reference/create-session.md): Creates a session for embedded payment flows (COLLECT_DETAILS or COMPLETE_PAYMENT). - [Get Session Details](https://docs.myfatoorah.com/reference/get-session-details.md): Retrieves detailed information about a specific session, including its status, transaction results, and card details. - [Get Invoice by InvoiceId](https://docs.myfatoorah.com/reference/get-invoice-by-invoiceid.md) - [Get Invoice by ExternalIdentifier](https://docs.myfatoorah.com/reference/get-invoice-by-externalidentifier.md) - [Get Customer Details](https://docs.myfatoorah.com/reference/get-customer-details.md): Retrieves the details of a customer including the cards saved with his reference. - [SendPayment](https://docs.myfatoorah.com/reference/send-payment.md): Creates a MyFatoorah invoice. This endpoint generates an invoice link that can be sent to customers via email, SMS, or returned directly in the response. - [InitiatePayment](https://docs.myfatoorah.com/reference/initiate-payment.md): Retrieves all available and enabled payment methods of your portal account with the commission charge that the customer may pay on the gateway. This endpoint does not execute or store any payment information, it just gets the proper information based on your MyFatoorah profile and calculates the service charges. - [InitiateSession](https://docs.myfatoorah.com/reference/initiate-session.md): Initiates a session for Embedded Integration - [ExecutePayment](https://docs.myfatoorah.com/reference/execute-payment.md): Creates a MyFatoorah invoice against a certain gateway. This endpoint processes the payment with a specific payment method and returns the payment URL where the customer should be redirected to complete the payment. - [GetPaymentStatus](https://docs.myfatoorah.com/reference/get-payment-status.md): Checks the status of an invoice to verify whether the payment has been completed successfully. This endpoint allows you to inquire about payment status using InvoiceId, PaymentId, or CustomerReference. - [UpdatePaymentStatus](https://docs.myfatoorah.com/reference/update-payment-status.md): Updates the payment status by either capturing fully/partially the invoice amount or releasing the amount back into the customer's account. This endpoint is used for authorization and capture operations. Note: You can make only one Capture/Release operation on each invoice. - [UpdateSession](https://docs.myfatoorah.com/reference/update-session.md): Updates a payment session with payment token information. This endpoint accepts MyFatoorah tokens, and tokens for native wallet integrations. - [CancelToken](https://docs.myfatoorah.com/reference/cancel-token.md): Cancels a saved card token - [DirectPayment](https://docs.myfatoorah.com/reference/direct-payment.md): Facilitates the payment process by directly executing payments using card details or saved tokens. Note: This endpoint can be used if your system PCI certified - [GetRecurringPayment](https://docs.myfatoorah.com/reference/get-recurring-payment.md): Retrieves all recurring payments created in your account. This endpoint returns a list of all recurring payments with their status, execution details, and related invoices. - [CancelRecurringPayment](https://docs.myfatoorah.com/reference/cancel-recurring-payment.md): Cancels a recurring payment by its recurring ID. Once canceled, the recurring payment will stop executing future scheduled payments. - [ResumeRecurringPayment](https://docs.myfatoorah.com/reference/resume-recurring-payment.md): Manually retries a failed recurring payment. This endpoint is used only with uncompleted recurring payments where the recurring status is inactive. - [RegisterApplePayDomain](https://docs.myfatoorah.com/reference/register-apple-pay-domain.md): Registers your domain to use Apple Pay in embedded integration. You need to host the Apple Pay verification file on your domain before calling this endpoint. - [MakeRefund](https://docs.myfatoorah.com/reference/make-refund.md): Cancels a payment and returns the funds to the customer. This endpoint can be used for full or partial refunds. The refund can be processed using either InvoiceId or PaymentId. - [MakeSupplierRefund](https://docs.myfatoorah.com/reference/make-supplier-refund.md): Cancels a payment and returns the funds to the customer for invoices that have supplier information. This endpoint is specifically designed for the Multiple Suppliers feature and accepts invoices that contain one or more suppliers. - [GetRefundStatus](https://docs.myfatoorah.com/reference/get-refund-status.md): Gets the status of a refund to check if it is refunded, rejected, or still pending. - [CreateSupplier](https://docs.myfatoorah.com/reference/create-supplier.md): Adds a new supplier to your MyFatoorah account. This endpoint is used to create suppliers for multi-vendor functionality, and determine supplier's basic settings. - [EditSupplier](https://docs.myfatoorah.com/reference/edit-supplier.md): Edits information about a certain supplier. If the supplier is approved, the request to update the supplier will be reviewed first by MyFatoorah team before approving or rejecting it. While a request is under review, you cannot create another request. Upon approval or rejection of the changes, you will receive a webhook. - [CustomizeSupplierCommissions](https://docs.myfatoorah.com/reference/customize-supplier-commissions.md): Sets a customized commission for the supplier based on the payment method that will be used to make the payment. This allows different commission structures for different payment methods. - [TransferBalance](https://docs.myfatoorah.com/reference/transfer-balance.md): Transfers a balance from or to the available balance of a supplier. This endpoint works with a single supplier at each request and is specifically designed for the Multi-Vendors feature. - [UploadSupplierDocument](https://docs.myfatoorah.com/reference/upload-supplier-document.md): Uploads supplier documents. Files must be maximum 5 MB and in the following formats: .jpg, .jpeg, .png, .bmp, .gif, .xls, .xlsx, .pdf, .doc, .docx - [GetSuppliers](https://docs.myfatoorah.com/reference/get-suppliers.md): Retrieves a list that contains full information about your suppliers. - [GetSupplierDetails](https://docs.myfatoorah.com/reference/get-supplier-details.md): Retrieves full information about a specific supplier. - [GetSupplierDeposits](https://docs.myfatoorah.com/reference/get-supplier-deposits.md): Gets the deposit records of a supplier. - [GetSupplierDocuments](https://docs.myfatoorah.com/reference/get-supplier-documents.md): Gets the supplier documents. - [GetSupplierDashboard](https://docs.myfatoorah.com/reference/get-supplier-dashboard.md): Gets the supplier dashboard information, including transaction statistics, balance details, and approval status. - [GetCountries](https://docs.myfatoorah.com/reference/get-countries.md): Retrieves a list of countries with their codes. This endpoint is used to get available countries for shipping operations. - [GetCities](https://docs.myfatoorah.com/reference/get-cities.md): Retrieves a list of cities that belong to a certain country. You can also search for a specific city name in a certain country. - [RequestPickup](https://docs.myfatoorah.com/reference/request-pickup.md): Request a pickup for orders with Prepared status to be delivered via DHL or ARAMEX. - [GetShippingOrderList](https://docs.myfatoorah.com/reference/get-shipping-order-list.md): Retrieves the shipping orders list that belongs to either DHL or ARAMEX. - [CalculateShippingCharge](https://docs.myfatoorah.com/reference/calculate-shipping-charge.md): Calculates the shipping charge supported by the MyFatoorah Shipping Module for either DHL or ARAMEX. You should provide the CityName and CountryCode parameters which can be retrieved by the GetCities and GetCountries endpoints respectively. - [UpdateShippingStatus](https://docs.myfatoorah.com/reference/update-shipping-status.md): Updates the status of shipping orders supported by the MyFatoorah Shipping Module for either DHL or ARAMEX. Use this endpoint to change the status of shipping invoices. - [GetBanks](https://docs.myfatoorah.com/reference/get-banks.md): Retrieves a list of available banks for your region with their identifiers and names. - [GetCurrenciesExchangeList](https://docs.myfatoorah.com/reference/get-currencies-exchange-list.md): Retrieves a list of currencies with their exchange rates against your base currency (Dashboard Currency). - [GetDepositedInvoices](https://docs.myfatoorah.com/reference/get-deposited-invoices.md): Retrieves the list of invoices included in a specific deposit by deposit reference. - [GetWebhooks](https://docs.myfatoorah.com/reference/get-webhooks.md): Retrieves all webhook events triggered by MyFatoorah to your endpoint based on webhook configuration and delivery status. Useful for retrieving missed webhook events if your server was down or slow.