HomeGuidesAPI Reference
Guides

Features & Capabilities

Guides › Features & Capabilities

A complete reference to everything EdfaPay supports — from payment methods and integration modes to security, webhooks, and developer tooling. Use this page as your map to the full platform.


Table of Contents

  1. Payment Methods — Overview of supported payment options such as cards, wallets, and alternative methods.
  2. Integration Modes — Different ways to integrate (hosted checkout, embedded, server-to-server).
  3. Apple Pay — Setup and processing payments using Apple Pay.
  4. SoftPOS — Accept in-person payments using NFC-enabled Android devices (tap-to-pay).
  5. Payment Links & Invoicing — Create and send payment links or invoices to customers.
  6. 3D Secure (3DS) — Handling cardholder authentication for secure online payments.
  7. Tokenization & Recurring Payments — Save cards securely and perform repeat or scheduled payments.
  8. Webhooks — Receive real-time payment status updates via server callbacks.
  9. Reporting & Reconciliation — Access transaction reports and match payments with settlements.
  10. Payouts & Escrow — Manage fund disbursement, settlements, and escrow flows.
  11. Partner & White Label — Solutions for resellers and branded payment platforms.
  12. Compliance & Security — Standards like PCI DSS and data protection practices.
  13. Developer Tools — SDKs, APIs, Postman collections, and testing utilities.

1. Payment Methods

EdfaPay supports local and international payment methods through a single integration, covering the major card networks and digital wallets used across the GCC and globally.

Payment MethodTypeRegion
VISACredit & DebitGlobal
MastercardCredit & DebitGlobal
MadaDebitSaudi Arabia
Apple PayDigital WalletGlobal
AMEXCredit & ChargeGlobal
TamaraBuy Now, Pay LaterGCC

Default Availability: Visa, Mastercard, Mada, and Apple Pay are enabled by default for all approved accounts. Additional methods such as Tamara and international cards require activation via the Operations Team.

📘 Note: EdfaPay continuously adds new payment methods. Contact [email protected] for the latest availability and activation requests.

📄 Payment Methods Guide


2. Integration Modes

EdfaPay's Payment Gateway supports two integration models. Both process the same payment methods and connect to the same infrastructure — the difference is who controls the checkout UI and who holds PCI responsibility.

Hosted Checkout

A pre-built, EdfaPay-hosted payment page. Your backend creates a session, receives a payment URL, and redirects the customer. EdfaPay handles the entire checkout experience including 3DS, card validation, and error handling.

Best for: Fast implementation, teams without backend card-handling experience, merchants who want EdfaPay to own PCI compliance.

CharacteristicDetail
Card data handlingManaged entirely by EdfaPay
PCI responsibilityEdfaPay
Implementation effortLow — backend session creation + redirect
3D SecureAutomatic
CustomizationCheckout templates available

📄 Checkout Integration Guide 🔗 Initiate Payment API | Transaction Status API


Embedded S2S (Server-to-Server)

Full backend integration where your server sends card data directly to https://api.edfapay.com/payment/post via POST multipart/form-data. You control the entire checkout UI; EdfaPay handles processing, 3DS orchestration, and settlement.

Best for: Custom checkout experiences, mobile apps, merchants who need full control over the payment flow.

CharacteristicDetail
Card data handlingSent server-to-server — never via browser
PCI responsibilityMerchant
Implementation effortMedium — requires hash generation and 3DS handling
3D SecureVia redirect_url in API response
Supported operationsSALE, AUTH, CAPTURE, REFUND, RECURRING

Required fields in every S2S request: action, client_key, order_id, order_amount, order_currency, card data, payer info, and a cryptographic hash.

📄 Embedded Integration Guide


3. Apple Pay

EdfaPay supports Apple Pay through both integration models, enabling native Apple Pay buttons in web and mobile checkout flows.

  • Hosted Checkout: Apple Pay is enabled automatically on supported devices — no additional configuration needed beyond account activation.
  • Embedded Integration: Integrate the Apple Pay button directly into your custom UI using EdfaPay's embedded Apple Pay SDK.

Both flows require Apple Pay merchant registration and domain verification prior to going live.


4. EdfaPay SoftPOS

SoftPOS turns a supported Android device into a contactless payment terminal — no physical hardware required. It is purpose-built for merchants who need in-store payments without the cost or complexity of traditional POS systems.

Capabilities:

  • Accept contactless card payments and digital wallets directly on Android
  • Manage multiple branches, terminals, and operators from a single dashboard
  • Generate payment links and track transaction history per terminal
  • Full reconciliation and reporting

Operations managed from the SoftPOS dashboard:

FeatureLink
Branch Managementdocs/branch-management
Terminal Managementdocs/terminal
Token Managementdocs/token
System & Device Requirementsdocs/system-device-requirements
SoftPOS SDKguides.edfapay.com/docs/softpos-sdk

📄 SoftPOS Getting Started 📄 SoftPOS Overview


5. Payment Links & Invoicing

The Payment Link (Pay by Link) feature lets merchants generate and share secure payment URLs without requiring any checkout integration on the customer-facing side.

  • Create links directly from the EdfaPay Dashboard
  • Share via email, SMS, or WhatsApp
  • Customers pay on a secure, EdfaPay-hosted page
  • Full payment tracking and status updates in the dashboard

Ideal for: Service businesses, freelancers, B2B invoicing, and any scenario where the customer is not present at a web checkout.

📄 Payment Link Guide


6.3D Secure (3DS)

EdfaPay supports 3D Secure authentication on all card transactions. The implementation differs slightly depending on your integration type.

Hosted Checkout: 3DS is handled entirely by EdfaPay — no additional implementation required.

Embedded S2S: When 3DS is triggered, the API response includes:

  • redirect_url — the 3DS authentication endpoint
  • redirect_params.body — a Base64-encoded payload to POST to that URL

Your application must POST the redirect_params.body to the redirect_url and render the returned HTML page inside a WebView or iframe.

// POST body to redirect_url
{
  "body": "BASE64_ENCODED_STRING"
}

After successful authentication, EdfaPay redirects to your term_url_3ds and sends a webhook with the final transaction status.

🚧 Critical: Never decode or modify the Base64-encoded body. It is cryptographically signed. Altering it will break authentication.

📄 3D Secure Guide


7.Tokenization & Recurring Payments

EdfaPay supports card tokenization and recurring billing to enable subscription-based and installment payment models.

Tokenization: Cards are stored securely by EdfaPay and returned as a reusable token. Subsequent transactions reference the token — no need to re-collect card details from the customer.

Recurring Payments: Use the RECURRING action in the S2S API to schedule or trigger automated charges against a stored token. Supports subscriptions, installment plans, and membership renewals.

The Hosted Checkout integration also supports recurring payment setup through the checkout flow.

🔗 Recurring Payments API Reference 📄 Checkout Integration — Recurring


8. Webhooks

Webhooks are a required component of any EdfaPay integration. They are the primary mechanism for receiving real-time, authoritative transaction status updates.

EdfaPay sends webhook notifications for:

  • Successful payments
  • Declined transactions
  • Refunds processed
  • Recurring charges
  • 3DS authentication outcomes

Configuration

Set your webhook endpoint URL in the EdfaPay Dashboard. EdfaPay will POST signed JSON payloads to that URL for every relevant event.

Validation

Every incoming webhook includes a hash. Validate it against your secret password before acting on the payload to confirm the notification is genuine.

Testing

During development, use Webhook.site or the built-in webhook simulator to inspect payloads before connecting your production endpoint.

ResourceLink
Webhook Overviewdocs/webhook
Configurationdocs/webhook-information
Logs & Historydocs/webhook-logs-history
Operation Typesdocs/webhook-operation-types
Payloadsdocs/webhook-payloads
Testing Webhooksdocs/testing-webhooks

9. Reporting & Reconciliation

The EdfaPay Dashboard provides full visibility into your payment operations in real time.

Available from the dashboard:

  • Transaction history with filtering by date, status, method, and amount
  • Settlement reports and payout summaries
  • Reconciliation exports for accounting and finance workflows
  • Per-terminal and per-branch reporting for SoftPOS merchants

📄 Reports & Transactions 📄 Reconciliation


10. Payouts & Escrow

EdfaPay supports a controlled payout flow through an escrow account system, giving partners and platforms greater control over when and how funds are disbursed to merchants.

  • Funds are held in an escrow account after processing
  • Transactions are confirmed and queued for payout by the platform
  • Settlement is released based on the configured payout schedule

📄 Escrow Account Guide 📄 Confirm Transaction for Payout Queue


11. Partner & White Label

EdfaPay offers a full white label program for payment platforms, ISOs, and fintechs who want to offer branded payment experiences to their own merchants.

Partner capabilities include:

  • Custom branding — logos, colors, themes, and checkout UI
  • Merchant management — onboard, configure, and manage sub-merchants via API or dashboard
  • APK customization for SoftPOS deployments
  • Multi-channel communication setup — email, SMS, and WhatsApp per merchant
  • Full fee and settlement configuration per merchant
ResourceLink
Partner Overviewdocs/overview-3
White Label Solutionsdocs/edfapay-white-label-solutions
Configuration Requirementsdocs/partner-configuration-requirements
Theme Configurationdocs/theme-configuration
Email, SMS & WhatsApp Configdocs/email-sms-whatsapp-configuration
Merchant Managementdocs/merchant-management
APK Customizerdocs/apk-customizer
Merchant Onboarding APIdocs/merchant-onboarding-api

12. Compliance & Security

EdfaPay is built on PCI-DSS Level 1 certified infrastructure — the highest level of payment security certification available.

Security stack:

  • PCI-DSS Level 1 certified processing
  • Per-request hash-based API authentication
  • 3D Secure (3DS) authentication on all card transactions
  • Fraud monitoring and risk scoring
  • Server-to-server card data transmission — card data never passes through a browser
  • HTTPS enforced on all endpoints
ResourceLink
Fraud Plandocs/fraud-plan
3D Securedocs/3d-secure
Transaction Decline Codesdocs/transaction-decline-codes
International Paymentsdocs/international-payment

13. Developer Tools

Postman Collection

The EdfaPay Postman Collection includes all API endpoints pre-configured with the correct request structure, headers, and example payloads. It is the fastest way to explore and test the API before writing integration code.

📘 Recommended first step for all developers. Import the collection, set your client_key and password as environment variables, and run your first test transaction in minutes.

🔗 Download Postman Collection

API Reference

The full API reference documents every endpoint, required field, response schema, and error code.

EndpointDescriptionLink
Initiate PaymentCreate a checkout sessionreference/initiate
Transaction StatusRetrieve payment resultreference/transaction-status
Recurring PaymentsManage automated billingreference/recurring
Postman CollectionAll endpoints in one collectionreference/postman

Testing Environment

EdfaPay provides a full sandbox environment with test cards covering all payment outcomes — approved, declined, 3DS-required, and more.

ResourceLink
Sandbox Environmentdocs/sandbo-environment
Sandbox Dashboarddocs/edfapay-sandbox-dashboard
Test Cardsdocs/test-cards
Testing Guidedocs/testing-guide
Testing Webhooksdocs/testing-webhooks

Related Pages

PageLink
Getting Starteddocs/new-edfapay
Payment Gatewaydocs/getting-started
Checkout Integrationdocs/checkout-integration
Embedded Integrationdocs/overview
Authenticationdocs/authentication
Webhooksdocs/webhook
Go Live Checklistdocs/go-live-checklist
FAQsdocs/faqs
API Referencereference
Postman Collectionreference/postman

EdfaPay — A complete platform for modern payment experiences.