The Recurring API (S2S) allows merchants to charge customers on a recurring basis (e.g., subscriptions, installments) using a previously generated recurringToken.

This is an unscheduled recurring flow, meaning merchants control when charges are triggered from their backend systems.

Recurring Flow

Endpoint

POST https://app-api.edfapay.com/api/v2/payment-gateway/recurring

Content-Type: application/json

Authentication

All requests must include a valid X-API-KEY in the request header.

The API key must be generated from your dashboard and must only be used server-side.

👉 How to generate API key

🔐
Security Note

Never expose your API Key on the frontend or client-side applications.
Always send requests from your backend server.

Request Body

Field	Type	Required	Description
transactionId	String	Yes	Unique identifier for the recurring transaction.
recurringToken	String	Yes	Token received from the initial payment.
amount	Decimal	Yes	Amount to be charged.
order	Object	Yes	Order details object.

Order Object

Field	Type	Required	Description
number	String	Yes	Unique order number.
amount	Decimal	Yes	Order amount.
currency	String	Yes	Currency code (ISO 4217), e.g., `USD`, `SAR`.
description	String	Yes	Description of the order.

Example Request

curl --location 'https://app-api.edfapay.com/api/v2/payment-gateway/recurring' \
--header 'X-API-KEY: <Your API Key>' \
--header 'Content-Type: application/json' \
--data '{
  "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recurringToken": "token",
  "amount": 150.75,
  "order": {
    "number": "ORD-2025-000123",
    "amount": 150.75,
    "currency": "SAR",
    "description": "Monthly subscription payment"
  }
}'

How to Get `recurringToken`

To perform recurring payments, you must first obtain a recurringToken.

This token is generated during the initial payment under the following conditions:

The initial payment request includes recurring initialization (e.g., recurringInit = Y)
The transaction is successfully completed

The token is then returned in the callback/webhook response and must be stored securely for future use.

🔁
The same recurring token can be reused for future charges until it is expired or revoked.

Response Example

{
  "statusCode": 200,
  "responseBody": {
    "result": "SUCCESS",
    "status": "SUCCESS",
    "payment_id": "XXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

Important Notes

⚠️Important Notes

Recurring payments require a valid recurring token.
The initial transaction must be successful to generate the token.
Merchants are responsible for managing billing cycles and retry logic.
Always validate transaction responses and webhook notifications.