# EdfaPay API Documentation Documentation

> Integrate easily with EdfaPay payment gateway for online, in-store, and Apple Pay payments.

## Guides
- [Welcome to EdfaPay](https://docs.edfapay.com/docs/welcome-to-edfapay.md)
- [Overview](https://docs.edfapay.com/docs/getting-started.md)
- [Checkout Integration](https://docs.edfapay.com/docs/checkout-integration-1.md)
- [Embedded Integration](https://docs.edfapay.com/docs/overview.md)
- [Merchant Registration](https://docs.edfapay.com/docs/merchant-registration.md)
- [SandBox Environment](https://docs.edfapay.com/docs/sandbox-environment.md)
- [Edfapay SandBox Dashboard](https://docs.edfapay.com/docs/edfapay-sandbox-dashboard.md)
- [Production Environment](https://docs.edfapay.com/docs/production-environment-1.md)
- [Edfapay Production Dashboard ](https://docs.edfapay.com/docs/edfapay-production-dashboard-1.md)
- [User Roles & Permissions](https://docs.edfapay.com/docs/user-roles-permissions.md)
- [Edfapay Partner](https://docs.edfapay.com/docs/edfapay-partner.md)
- [Edfapay White Label Solutions](https://docs.edfapay.com/docs/edfapay-white-label-solutions.md): Boost your business with EdfaPay's fully branded payment platform. Choose between turnkey cloud-hosted or self-hosted models with advanced features like SoftPOS, subscription billing, and split payouts.
- [Partner Configuration Requirements](https://docs.edfapay.com/docs/partner-configuration-requirements.md)
- [Partner Features](https://docs.edfapay.com/docs/partner-features.md): Comprehensive guide to all features available to Partners in the EdfaPay platform, including merchant management, financial reporting, branding customization, and online registration management.
- [SMS Integration with EdfaPay](https://docs.edfapay.com/docs/sms-integration-with-edfapay.md)
- [Register New Merchant API](https://docs.edfapay.com/docs/registraion-api.md)
- [Extra Amount Feature](https://docs.edfapay.com/docs/extra-amount-feature.md)
- [EdfaPay Refund Integration](https://docs.edfapay.com/docs/edfapay-refund-integration.md)
- [Testing Guide](https://docs.edfapay.com/docs/testing-guide.md): Before going live, merchants must first integrate and test on the EdfaPay Sandbox Environment.
- [Test cards](https://docs.edfapay.com/docs/test-cards.md)
- [Go Live CheckList](https://docs.edfapay.com/docs/go-live-checklist.md)
- [Payment Methods](https://docs.edfapay.com/docs/payment-methods.md)
- [E-Invoice System](https://docs.edfapay.com/docs/e-invoice-system.md)
- [Overview](https://docs.edfapay.com/docs/overview-2.md)
- [Apple Pay Configuration](https://docs.edfapay.com/docs/apple-pay-configuration.md)
- [Embedded Apple Pay Integration](https://docs.edfapay.com/docs/embedded-apple-pay-integration.md)
- [Embedded Apple Pay— Configuration Guide](https://docs.edfapay.com/docs/embedded-apple-pay-configuration-guide.md)
- [Embedded Apple Pay — Implementation & Go-Live](https://docs.edfapay.com/docs/embedded-apple-pay-implementation-go-live.md)
- [Apple pay Embedded - Code](https://docs.edfapay.com/docs/apple-pay-embedded-code.md)
- [Apple Pay Integration guide with Edfapay](https://docs.edfapay.com/docs/apple-pay-integration-guide-with-edfapay.md)
- [Apple Pay—Troubleshooting & Error Codes](https://docs.edfapay.com/docs/apple-paytroubleshooting-error-codes.md)
- [Webhook](https://docs.edfapay.com/docs/webhook.md)
- [Webhook Information & Configuration](https://docs.edfapay.com/docs/webhook-information.md)
- [Webhook Operation Types](https://docs.edfapay.com/docs/webhook-operation-types.md)
- [Webhook Payloads](https://docs.edfapay.com/docs/webhook-payloads.md)
- [Testing Webhooks](https://docs.edfapay.com/docs/testing-webhooks.md)
- [Webhook Validation](https://docs.edfapay.com/docs/webhook-validation.md)
- [Authentication](https://docs.edfapay.com/docs/authentication.md)
- [Plugins](https://docs.edfapay.com/docs/plugins.md)
- [WooCommerce Integration with EdfaPay](https://docs.edfapay.com/docs/copy-of-woocommerce.md): Discover how to integrate EdfaPay with WooCommerce for secure online payments. Follow detailed setup instructions and explore various integration options.
- [Plugin Installation](https://docs.edfapay.com/docs/copy-of-plugin-installation.md)
- [Plugin Settings for EdfaPay WooCommerce](https://docs.edfapay.com/docs/copy-of-checkout-integration.md)
- [CS Cart](https://docs.edfapay.com/docs/cs-cart.md)
- [EdfaPay Payment Gateway Mobile SDKs](https://docs.edfapay.com/docs/mobile-sdks.md)
- [Flutter](https://docs.edfapay.com/docs/flutter.md)
- [IOS](https://docs.edfapay.com/docs/ios.md)
- [Android](https://docs.edfapay.com/docs/android.md)
- [International payment](https://docs.edfapay.com/docs/international-payment.md)
- [Tamara Payment Method](https://docs.edfapay.com/docs/tamara.md)
- [Fraud Plan](https://docs.edfapay.com/docs/fraud-plan.md)
- [Transaction Decline Codes](https://docs.edfapay.com/docs/transaction-decline-codes.md)
- [3D Secure](https://docs.edfapay.com/docs/3d-secure.md)
- [FAQS](https://docs.edfapay.com/docs/faqs.md)
- [Features](https://docs.edfapay.com/docs/features-1.md)

## API Reference
- [Overview](https://docs.edfapay.com/reference/overview-1.md)
- [Payment Gateway](https://docs.edfapay.com/reference/payment-gateway.md)
- [Checkout Integration](https://docs.edfapay.com/reference/hosted-checkout-integration.md)
- [Initiate](https://docs.edfapay.com/reference/get_new-endpoint.md): Initiate a hosted checkout session to redirect the customer to a secure Edfapay payment page.
- [Status](https://docs.edfapay.com/reference/status-api-copy.md)
- [Recurring](https://docs.edfapay.com/reference/recurring-payment.md)
- [Full Refund](https://docs.edfapay.com/reference/full-refund.md)
- [Partial Refund](https://docs.edfapay.com/reference/partial-refund.md): Learn how to process partial refunds using the EdfaPay payment gateway, including request structure, hash calculation, and guidelines.
- [Embedded Integration S2S](https://docs.edfapay.com/reference/hosted-integration-s2s.md)
- [Embedded Card Payment](https://docs.edfapay.com/reference/sale.md)
- [Status](https://docs.edfapay.com/reference/status.md)
- [Transaction Details](https://docs.edfapay.com/reference/status-1.md)
- [Authorize](https://docs.edfapay.com/reference/sale-2.md)
- [Capture](https://docs.edfapay.com/reference/capture-1.md)
- [Full Refund](https://docs.edfapay.com/reference/s2s-full-refund.md)
- [Partial Refund](https://docs.edfapay.com/reference/s2s-partial-refund.md)
- [Credit Void](https://docs.edfapay.com/reference/refund-capture.md)
- [Recurring](https://docs.edfapay.com/reference/recurring-1.md)
- [Extra Amount](https://docs.edfapay.com/reference/sale-1.md)
- [Embedded Apple Pay — SALE API](https://docs.edfapay.com/reference/embedded-apple-pay-sale-api.md)
- [Webhook (Callback) API](https://docs.edfapay.com/reference/webhook-callback-api.md)
- [Overview ](https://docs.edfapay.com/reference/overview.md)
- [tokenized-sale](https://docs.edfapay.com/reference/tokenized-sale.md)
- [Retrieve Saved Cards](https://docs.edfapay.com/reference/retrieve-saved-cards.md)
- [pay-with-token](https://docs.edfapay.com/reference/pay-with-token.md)
- [Tamara](https://docs.edfapay.com/reference/get_new-endpoint-1.md): This is your first endpoint! Edit this page to start documenting your API.
- [Sandbox Environment: Checkout API Integration and Testing](https://docs.edfapay.com/reference/default.md)
- [Initiate](https://docs.edfapay.com/reference/post_payment-initiate.md): Initiate a hosted checkout session to redirect the customer to a secure Edfapay payment page.
- [Status](https://docs.edfapay.com/reference/post_payment-status.md)
- [Full Refund](https://docs.edfapay.com/reference/full-refund-sandbox.md): Learn about testing the Full Refund API, including rules, guidelines, and conditions for processing refunds through Edfapay.
- [Partial Refund](https://docs.edfapay.com/reference/full-refund-sandbox-1.md): Learn how to process partial refunds using the EdfaPay payment gateway, including request structure, hash calculation, and guidelines.
- [Recurring](https://docs.edfapay.com/reference/post_payment-recurring.md)
- [Sandbox Environment: S2S API Integration and Testing](https://docs.edfapay.com/reference/edfapay-s2s.md)
- [Embedded Card Payment](https://docs.edfapay.com/reference/post_payment-post-1.md)
- [Status](https://docs.edfapay.com/reference/post_payment-post-1-1.md)
- [Capture](https://docs.edfapay.com/reference/post_payment-post-1-1-1.md)
- [Transaction Details ](https://docs.edfapay.com/reference/transaction-details.md)
- [Full Refund](https://docs.edfapay.com/reference/s2s-full-refund-sandbox.md)
- [Partial Refund](https://docs.edfapay.com/reference/s2s-full-refund-sandbox-1.md): Learn about the Partial Refund S2S API, including rules, guidelines, and conditions for processing refunds through Edfapay.
- [Credit Void](https://docs.edfapay.com/reference/post_payment-post-1-1-1-1-1.md)
- [Recurring](https://docs.edfapay.com/reference/post_payment-post.md)
- [Extra Amount](https://docs.edfapay.com/reference/post_payment-post-1-2.md)
- [Postman](https://docs.edfapay.com/reference/postman.md)
- [Register New Merchant API](https://docs.edfapay.com/reference/register-merchant.md): Register and onboard new merchants into the system through a multipart/form-data API request, including required business details and supporting documents.