Skip to documentation
Developer reference API Documentation
Free Sadad · REST / JSON

A precise field guide for every payment request.

Integrate telecom payments, inquiries, games, gift cards, balance tracking, and webhooks through one structured reference built for implementation and production support.

Start integration Payment endpoints
Base endpoint https://free-sadad.com/rest-api
Payload JSON
Transport HTTPS
Navigation map

Everything in this reference

Nine focused chapters arranged from access setup through payment execution, tracking, callbacks, and final response handling.

01 Start here Getting Started Base URL, credentials, request conventions, security rules, and the complete integration flow. 02 Access Authentication Generate the access token used to authenticate every protected API request. 03 Account Account APIs Account balance and balance-feed requests with complete response examples. 04 Catalog Catalog APIs Games, gift cards, bundle offers, and recharge-category discovery. 05 Inquiry Subscriber Inquiries Subscriber and service inquiry requests with their successful and failed response shapes. 06 Execution Payment Operations Balance, bundle, game, gift-card, and manual-service payment requests. 07 Tracking Operation Lifecycle Operation states, single and bulk status checks, and safe handling of uncertain outcomes. 08 Callbacks Webhooks Asynchronous status notifications, callback parameters, and delivery format. 09 Outcomes Responses & Errors JSON outcomes, HTTP status codes, error meanings, and the correct integration response.
01
Start here

Getting started

This chapter introduces the complete integration journey—from obtaining access credentials and authenticating requests to submitting transactions, tracking their outcomes, and handling asynchronous notifications safely.

Integration journey

Understand the integration journey before sending your first transaction.

Begin by preparing your credentials and authentication flow. Then explore the available capabilities, follow the documented request contract for the required operation, submit each transaction with a unique reference, and track it until a final outcome is confirmed.

Production base URL https://free-sadad.com/rest-api
1AuthenticateObtain secure API access.
2ExploreReview the available inquiries, catalogs, and payment operations.
3SubmitSend one unique transaction reference with the request.
4TrackConfirm the final result through status queries or webhooks.
API configuration

Request and response conventions

Request methodPOST
Content-Typeapplication/json
Response formatJSON
Character encodingUTF-8
Important security notice

Protect the integration boundary

  • Keep API credentials secure and never expose them in client-side code.
  • Use HTTPS for all API requests to ensure data encryption.
  • Implement proper error handling without exposing sensitive information.
  • Rotate API tokens regularly for enhanced security.
  • When a payment outcome is uncertain, query its original TransactionID instead of submitting it again.
02
Access

Authentication

Create the login signature locally, exchange it for an access token, and attach that token to every protected request.

Login signature md5(UserName + AccountNumber + md5(Password) + APIToken)
Step 1

Generate the signature

Preserve the exact value order and concatenate the values without separators. The password is MD5-hashed before it is included in the outer hash.

PHP 
$token = md5( $userName . $accountNumber . md5($password)  . $apiToken );
Step 2

Exchange it for an access token

Send the signature to the public login endpoint. Store the returned token until token_expires, then obtain a new one.

POST https://free-sadad.com/rest-api/login
POST
Authentication

Login

Public endpoint
Endpoint https://free-sadad.com/rest-api/login

Exchange the generated signature for the access_token used by protected API requests.

Request bodyAll fields are required
Field Description Required
AccountNumber Your assigned API account number. Required
UserName Your assigned API username. Required
Token The signature generated with the authentication formula. Required
Request example 
{
    "AccountNumber": "YOUR_ACCOUNT_NUMBER",
    "UserName": "YOUR_USERNAME",
    "Token": "GENERATED_MD5_TOKEN"
}
Success response 
{
    "status": true,
    "message": "Login Successful",
    "access_token": "*********************",
    "token_expires": "2024-08-05 19:31:45"
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
03
Account

Account APIs

Retrieve the available account balance and the balance-feed records associated with your API account.

Account-level requests

Use NetworkNumber 0 for account APIs

Set NetworkNumber to 0, then select the account request using ServiceNumber.

Account balanceServiceNumber = 1
Balance feedServiceNumber = 3
POST
Account

Get Account Balance

Access token required
Endpoint https://free-sadad.com/rest-api

Retrieve the current balance available to your API account.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Request fieldsAccount service 1
FieldValueDescription
NetworkNumber0Account network number.
ServiceNumber1Account-balance query service.
Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 1
}
Success response 
{
    "status": true,
    "agentBalance": 100,
    "message": "Agent Balance Query Success",
    "transactionID": 0
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
POST
Account

Get Feed Clients Balance

Access token required
Endpoint https://free-sadad.com/rest-api

Retrieve balance-feed records added to your account.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Request fieldsAccount service 3
FieldValueDescription
NetworkNumber0Account network number.
ServiceNumber3Client balance-feed service.
Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 3
}
Success response 
{
    "status": true,
    "data": [
        {
            "Date": "2024-08-03",
            "Amount": "70000.00000",
            "Currency": "ريال يمني",
            "Notes": "Notes"
        },
        {
            "Date": "2024-08-01",
            "Amount": "100000.00000",
            "Currency": "ريال يمني",
            "Notes": "Notes"
        }
    ],
    "message": "Query Success"
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
04
Catalog

Catalog APIs

Retrieve the product identifiers, prices, limits, required fields, bundle codes, and recharge categories needed before submitting a payment.

Catalog requests

Load product data before payment

Catalog requests use NetworkNumber = 0. Use the returned LinkCode, OfferCode, identifiers, limits, and required fields in the corresponding payment request.

Catalog availability and prices may vary by account. The response examples below are generated from the current catalog; always use the latest API response when submitting a payment.

Games and gift cardsServiceNumber = 4
Bundle offersServiceNumber = 5
Recharge categoriesServiceNumber = 7
POST
Catalog

Get Games and Gift Cards Categories

Access token required
Endpoint https://free-sadad.com/rest-api

Retrieve available products with pricing, quantity limits, LinkCode, and required fulfillment fields.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Request fieldsCatalog service 4
FieldValueDescription
NetworkNumber0Catalog network number.
ServiceNumber4Games and gift-card categories service.
Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 4
}
Complete catalog response example 
{
    "status": true,
    "data": [
        {
            "TheNumber": 334,
            "ServiceName": "ماستر كارد",
            "CategoryName": "بطاقة ماستر كارد - مسبقة الدفع 10$",
            "GameUnitsCount": 0,
            "LinkCode": "mast_10_new",
            "Price": 6835.95,
            "CurrencyName": "YER",
            "DefaultPrice": 6835.95,
            "DefaultCurrencyName": "YER",
            "LocalPrice": 6835.95,
            "LocalCurrencyName": "YER",
            "AllowFreeQuantity": false,
            "MinQuantity": 1,
            "MaxQuantity": 1,
            "RequiredFields": [
                {
                    "FieldCode": "MobileNumber",
                    "FieldName": "رقم الهاتف"
                }
            ]
        },
        {
            "TheNumber": 1,
            "ServiceName": "ماستر كارد",
            "CategoryName": "ماستر 10 دولار",
            "GameUnitsCount": 1,
            "LinkCode": "mast_10",
            "Price": 1477.2769230735,
            "CurrencyName": "YER",
            "DefaultPrice": 1477.2769230735,
            "DefaultCurrencyName": "YER",
            "LocalPrice": 1477.2769230735,
            "LocalCurrencyName": "YER",
            "AllowFreeQuantity": false,
            "MinQuantity": 1,
            "MaxQuantity": 1,
            "RequiredFields": [
                {
                    "FieldCode": "MobileNumber",
                    "FieldName": "رقم الهاتف"
                }
            ]
        },
        {
            "TheNumber": 1709,
            "ServiceName": "صدفة شات - Sodfa",
            "CategoryName": "صدفة شات -حسب الطلب",
            "GameUnitsCount": 0,
            "LinkCode": "Sodfa",
            "Price": 0.03102,
            "CurrencyName": "YER",
            "DefaultPrice": 0.03102,
            "DefaultCurrencyName": "YER",
            "LocalPrice": 0.03102,
            "LocalCurrencyName": "YER",
            "AllowFreeQuantity": true,
            "MinQuantity": 10000,
            "MaxQuantity": 1000000,
            "RequiredFields": [
                {
                    "FieldCode": "PlayerID",
                    "FieldName": "رقم ايدي - اللاعب"
                }
            ]
        }
    ],
    "message": "Success",
    "transactionID": 0
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
POST
Catalog

Telecom catalog queries

Access token required
Endpoint https://free-sadad.com/rest-api

Retrieve bundle offers or recharge categories for a selected telecom network.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
ServiceNumberQueryNetwork selectorPurpose
5Get Offers ListOffersNetworkNumberReturns the available bundles for one network.
7Get Charge Categories ListChargeCategoriesNetworkNumberReturns the available recharge categories for one network.
5
Catalog query

Get Offers List

OffersNetworkNumber selects the telecom network whose available packages are returned.

Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 5,
    "OffersNetworkNumber": 2
}
Success response 
{
    "status": true,
    "data": [
        {
            "TheNumber": 79,
            "NetworkName": "يــــو",
            "OfferName": "باقة سمارت نت الأسبوعية | 2 جيجا",
            "OfferNameEnglish": "باقة سمارت نت الأسبوعية | 2 جيجا",
            "LineTypeName": "شريحة",
            "PaymentTypeName": "دفع مسبق + فوترة",
            "OfferCode": "WeeklyPRE2GB",
            "OfferCost": 1210,
            "UnitsCount": 1000,
            "UnitPrice": 1.21,
            "CallMinutes": "0",
            "SMS": "0",
            "Internet3G": "2 جيجا",
            "Internet4G": "0",
            "Validity": "اسبوع",
            "DisableAdditionalServiceFees": 0
        },
        {
            "TheNumber": 72,
            "NetworkName": "يــــو",
            "OfferName": "باقة مكس الاسبوعية",
            "OfferNameEnglish": "باقة مكس الاسبوعية",
            "LineTypeName": "شريحة",
            "PaymentTypeName": "دفع مسبق + فوترة",
            "OfferCode": "PREWeeklyMix",
            "OfferCost": 496,
            "UnitsCount": 410,
            "UnitPrice": 1.21,
            "CallMinutes": "75 دقيقة",
            "SMS": "50 رسالة",
            "Internet3G": "100 ميجا",
            "Internet4G": "0",
            "Validity": "اسبوع",
            "DisableAdditionalServiceFees": 0
        }
    ],
    "message": "Success",
    "transactionID": 0
}
7
Catalog query

Get Charge Categories List

ChargeCategoriesNetworkNumber selects the telecom network and returns its cost, units, and unit price.

Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 7,
    "ChargeCategoriesNetworkNumber": 1
}
Success response 
{
    "status": true,
    "data": [
        {
            "ID": 87,
            "ClassID": null,
            "TheNumber": 8,
            "NetworkID": 1,
            "NetworkName": "يمن موبايل",
            "Name": "فئات  - يمن موبايل",
            "Cost": "0",
            "UnitsCount": "0",
            "UnitPrice": "0",
            "Notes": "backfill-default-parent-2026-08-24",
            "IsParent": 1,
            "ParentID": null,
            "ParentName": null,
            "ParentOrderNumber": null,
            "OrderNumber": 0,
            "TheOrderNumber": 0
        },
        {
            "ID": 1,
            "ClassID": 138,
            "TheNumber": 1,
            "NetworkID": 1,
            "NetworkName": "يمن موبايل",
            "Name": "200 وحدة",
            "Cost": "239",
            "UnitsCount": "200",
            "UnitPrice": "1.195",
            "Notes": "",
            "IsParent": 0,
            "ParentID": 87,
            "ParentName": "فئات  - يمن موبايل",
            "ParentOrderNumber": 0,
            "OrderNumber": 0,
            "TheOrderNumber": 0
        }
    ],
    "message": "Success",
    "transactionID": 0
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
05
Inquiry

Subscriber inquiries

Check supported subscribers using the correct network and service identifiers, with complete request and response contracts for every inquiry.

POST
Inquiry

Query subscriber information

Access token required
Endpoint https://free-sadad.com/rest-api

Select the subscriber inquiry by sending the correct NetworkNumber and ServiceNumber with the subscriber identifier and a unique TransactionID.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Common fieldsFull request contract
Field Example Description
NetworkNumber 1 Use the exact network identifier listed in the inquiry routing table below.
ServiceNumber 101 Use the exact service identifier listed in the inquiry routing table below.
MobileNumber 7XXXXXXXX The mobile number or fixed-service subscriber/account identifier being queried.
TransactionID XXXXXXXXX A unique transaction number for every inquiry request.
Available inquiry servicesNetwork and service routing
NetworkNumber ServiceNumber Inquiry Returned information
1 101 Query Yemen Mobile Balance Returns balance and subscriber type.
1 102 Query Yemen Mobile Loan Returns whether the subscriber currently has an outstanding loan.
1 107 Query Yemen Mobile Offers Returns the subscriber offers and their validity periods.
1 110 Yemen Mobile Full Query Returns subscriber type, balance, credit, loan, and active offers in one request.
4 404 Query Y Telecom Balance Returns the current subscriber balance for Y Telecom.
5 501 Query ADSL Balance Returns remaining data, expiry, offer amount, and minimum payment.
6 601 Query Landline Balance Returns the current landline balance.
7 701 Query Yemen 4G Balance Returns data balance, expiry, offer value, size, and call balance.
14 1401 Query Fiber Optic Balance Returns fiber account balance, expiry, current offer amount, and minimum payment.
13 1301 Query Aden Net Balance Returns account balance, expiry, current offer amount, and minimum payment.
101
Request and response example

Query Yemen Mobile Balance

Returns balance and subscriber type.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 101,
    "MobileNumber": "77XXXXXXX",
    "TransactionID": "QUERY-101"
}
Success response 
{
    "status": true,
    "mobileBalance": 154.15,
    "availableCredit": "",
    "mobileType": 1,
    "mobileTypeName": "دفع مسبق",
    "message": "Balance Query Success",
    "transactionID": "QUERY-101"
}
102
Request and response example

Query Yemen Mobile Loan

Returns whether the subscriber currently has an outstanding loan.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 102,
    "MobileNumber": "77XXXXXXX",
    "TransactionID": "QUERY-102"
}
Success response 
{
    "status": true,
    "loanStatus": false,
    "loanStatusString": "الرقم غير متسلف",
    "message": "Balance Query Success",
    "transactionID": "QUERY-102"
}
107
Request and response example

Query Yemen Mobile Offers

Returns the subscriber offers and their validity periods.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 107,
    "MobileNumber": "77XXXXXXX",
    "TransactionID": "QUERY-107"
}
Success response 
{
    "status": true,
    "data": [
        {
            "offerID": "A115887147",
            "offerName": "شريحه 4G",
            "offerStartDate": "2020-01-01 03:00:00",
            "offerEndDate": "2037-01-01 00:00:00"
        },
        {
            "offerID": "A4990006",
            "offerName": "باقة مزايا فورجي فولتي الشهريه دفع مسبق",
            "offerStartDate": "2024-07-21 17:14:06",
            "offerEndDate": "2024-08-19 23:59:59"
        },
        {
            "offerID": "A3825",
            "offerName": "دفع مسبق باقة نت توفير فورجي 5 جيجا الشهرية",
            "offerStartDate": "2024-07-26 18:01:40",
            "offerEndDate": "2024-08-24 23:59:59"
        }
    ],
    "message": "Balance Query Success",
    "transactionID": "QUERY-107"
}
110
Request and response example

Yemen Mobile Full Query

Returns subscriber type, balance, credit, loan, and active offers in one request.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 110,
    "MobileNumber": "77XXXXXXX",
    "TransactionID": "QUERY-110"
}
Success response 
{
    "status": true,
    "mobileType": 1,
    "mobileBalance": 154.15,
    "availableCredit": "",
    "mobileTypeName": "دفع مسبق",
    "loanStatus": false,
    "loanStatusString": "الرقم غير متسلف",
    "loanAmount": 0,
    "loanType": "",
    "data": [
        {
            "offerID": "A4990006",
            "offerName": "باقة مزايا فورجي فولتي الشهرية",
            "offerStartDate": "2026-08-01 12:00:00",
            "offerEndDate": "2026-08-30 23:59:59"
        }
    ],
    "message": "Full Query Success",
    "transactionID": "QUERY-110"
}
404
Request and response example

Query Y Telecom Balance

Returns the current subscriber balance for Y Telecom.

Request example 
{
    "NetworkNumber": 4,
    "ServiceNumber": 404,
    "MobileNumber": "70XXXXXXX",
    "TransactionID": "QUERY-404"
}
Success response 
{
    "status": true,
    "mobileBalance": 425.75,
    "message": "Success",
    "transactionID": "QUERY-404"
}
501
Request and response example

Query ADSL Balance

Returns remaining data, expiry, offer amount, and minimum payment.

Request example 
{
    "NetworkNumber": 5,
    "ServiceNumber": 501,
    "MobileNumber": "01XXXXXX",
    "TransactionID": "QUERY-501"
}
Success response 
{
    "status": true,
    "mobileBalance": "44.18 جيجابايت",
    "expiredDate": "21/10/2024",
    "offerAmount": "12600",
    "minAmount": "250",
    "message": "Balance Query Success",
    "transactionID": "QUERY-501"
}
601
Request and response example

Query Landline Balance

Returns the current landline balance.

Request example 
{
    "NetworkNumber": 6,
    "ServiceNumber": 601,
    "MobileNumber": "0XXXXXXX",
    "TransactionID": "QUERY-601"
}
Success response 
{
    "status": true,
    "mobileBalance": "2869",
    "message": "Balance Query Success",
    "transactionID": "QUERY-601"
}
701
Request and response example

Query Yemen 4G Balance

Returns data balance, expiry, offer value, size, and call balance.

Request example 
{
    "NetworkNumber": 7,
    "ServiceNumber": 701,
    "MobileNumber": "10XXXXXX",
    "TransactionID": "QUERY-701"
}
Success response 
{
    "status": true,
    "mobileBalance": "26.90جيجابايت",
    "expiredDate": "2024-11-06",
    "offerAmount": "2400",
    "offerSize": "2400",
    "callBalance": "",
    "message": "Balance Query Success",
    "transactionID": "QUERY-701"
}
1401
Request and response example

Query Fiber Optic Balance

Returns fiber account balance, expiry, current offer amount, and minimum payment.

Request example 
{
    "NetworkNumber": 14,
    "ServiceNumber": 1401,
    "MobileNumber": "10XXXXXX",
    "TransactionID": "QUERY-1401"
}
Success response 
{
    "status": true,
    "mobileBalance": "72.40 جيجابايت",
    "expiredDate": "2026-09-20",
    "offerAmount": "6000",
    "minAmount": "250",
    "message": "Balance Query Success",
    "transactionID": "QUERY-1401"
}
1301
Request and response example

Query Aden Net Balance

Returns account balance, expiry, current offer amount, and minimum payment.

Request example 
{
    "NetworkNumber": 13,
    "ServiceNumber": 1301,
    "MobileNumber": "ACCOUNT-ID",
    "TransactionID": "QUERY-1301"
}
Success response 
{
    "status": true,
    "mobileBalance": "18.50 جيجابايت",
    "expiredDate": "2026-09-15",
    "offerAmount": "3000",
    "minAmount": "250",
    "message": "Balance Query Success",
    "transactionID": "QUERY-1301"
}
Error example

Query failure response

The message contains the reason the query could not be completed.

Error response 
{
    "status": false,
    "message": "Error Message"
}
06
Execution

Payment operations

Submit recharge, payment, bundle, game, and digital-product operations through one authenticated endpoint, then read the operation outcome from the standard response envelope.

POST
Payment

Submit a payment

Access token required
Endpoint https://free-sadad.com/rest-api

Select the destination using NetworkNumber and ServiceNumber, include the service-specific fields, and assign one unique TransactionID to the payment.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Accepted payment outcomesRead operationStatus

When status is true, the payment request was accepted. Use operationStatus to determine its business outcome.

1CompletedThe payment finished successfully.
-1PendingKeep the operation pending and query it later.
0FailedThe accepted operation reached a failed result.
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1001",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1001",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1001",
    "referenceID": 243085,
    "statusCode": 200
}
Response fieldsPayment result envelope
FieldDescription
statusWhether the payment request was accepted. When true, read operationStatus for the payment outcome.
operationStatusThe operation state: 1 successful, 0 failed, or -1 pending.
agentBalanceThe agent account balance after the transaction.
priceThe price charged for the transaction.
commissionThe deferred commission value returned for the operation when available.
commissionCurrencyThe currency identifier of the returned commission, or null when no commission currency applies.
messageNotes or remarks describing the operation result.
transactionIDThe unique transaction identifier supplied by your system.
referenceIDThe transaction reference generated by the platform.
statusCodeThe HTTP status code represented in the response payload.
Request rejectionstatus = false

A response with status = false means the request could not be accepted. It is not the same as an accepted operation whose operationStatus is 0.

Rejected request response 
{
    "status": false,
    "message": "The request could not be accepted. Review the submitted fields and try again.",
    "statusCode": 400
}
Payment request examplesGenerated from the documented service directory

Use the network and service identifiers shown for each operation. Catalog-driven values such as OfferCode, LinkCode, required fields, and quantity limits must come from the corresponding catalog response available to your account.

103
Yemen Mobile · Network 1

Yemen Mobile Recharge

Recharges the subscriber balance and can activate a selected bundle in the same request.

NetworkNumber1
ServiceNumber103

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 1 Required The network identifier that owns the selected payment service.
ServiceNumber 103 Required The payment service identifier within the selected network.
TransactionID PAY-1-103-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The monetary value to recharge or pay to the Yemen Mobile subscriber number.
OfferCode OFFER_CODE Optional Send a valid Yemen Mobile OfferCode to activate a bundle together with the balance recharge.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge balanceRequest and response example

Recharge the subscriber balance without activating a bundle.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 103,
    "MobileNumber": "77XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-1-103-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1-103-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1-103-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1-103-1",
    "referenceID": 243085,
    "statusCode": 200
}
Recharge balance and activate a bundleRequest and response example

Recharge the balance and activate the selected Yemen Mobile bundle in one request.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 103,
    "MobileNumber": "77XXXXXXX",
    "Amount": 1000,
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-1-103-2",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1-103-2",
    "referenceID": 243086,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1-103-2",
    "referenceID": 243086,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1-103-2",
    "referenceID": 243086,
    "statusCode": 200
}
104
Yemen Mobile · Network 1

Renew Yemen Mobile Offer

Renews an active Yemen Mobile offer.

NetworkNumber1
ServiceNumber104

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 1 Required The network identifier that owns the selected payment service.
ServiceNumber 104 Required The payment service identifier within the selected network.
TransactionID PAY-1-104-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Renew an active bundleRequest and response example

Renew the selected active bundle for the subscriber.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 104,
    "MobileNumber": "77XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-1-104-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1-104-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1-104-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1-104-1",
    "referenceID": 243085,
    "statusCode": 200
}
108
Yemen Mobile · Network 1

Remove Yemen Mobile Offer

Removes the selected Yemen Mobile offer.

NetworkNumber1
ServiceNumber108

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 1 Required The network identifier that owns the selected payment service.
ServiceNumber 108 Required The payment service identifier within the selected network.
TransactionID PAY-1-108-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Remove an active bundleRequest and response example

Remove the selected active bundle from the subscriber.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 108,
    "MobileNumber": "77XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-1-108-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1-108-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1-108-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1-108-1",
    "referenceID": 243085,
    "statusCode": 200
}
109
Yemen Mobile · Network 1

Activate Yemen Mobile Offer

Activates the selected Yemen Mobile offer.

NetworkNumber1
ServiceNumber109

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 1 Required The network identifier that owns the selected payment service.
ServiceNumber 109 Required The payment service identifier within the selected network.
TransactionID PAY-1-109-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a bundleRequest and response example

Activate the selected bundle for the subscriber.

Request example 
{
    "NetworkNumber": 1,
    "ServiceNumber": 109,
    "MobileNumber": "77XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-1-109-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-1-109-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-1-109-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 0,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-1-109-1",
    "referenceID": 243085,
    "statusCode": 200
}
201
YOU Telecom · Network 2

YOU Charge Category

Recharges a YOU subscriber using a predefined charge category.

NetworkNumber2
ServiceNumber201

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 2 Required The network identifier that owns the selected payment service.
ServiceNumber 201 Required The payment service identifier within the selected network.
TransactionID PAY-2-201-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge using a charge categoryRequest and response example

Send the category value returned by the recharge-categories catalog.

Request example 
{
    "NetworkNumber": 2,
    "ServiceNumber": 201,
    "MobileNumber": "73XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-2-201-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-2-201-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-2-201-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-2-201-1",
    "referenceID": 243085,
    "statusCode": 200
}
202
YOU Telecom · Network 2

YOU Bundle Offer

Activates the selected YOU bundle offer.

NetworkNumber2
ServiceNumber202

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 2 Required The network identifier that owns the selected payment service.
ServiceNumber 202 Required The payment service identifier within the selected network.
TransactionID PAY-2-202-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a YOU bundleRequest and response example

Activate the bundle selected from the available YOU offers.

Request example 
{
    "NetworkNumber": 2,
    "ServiceNumber": 202,
    "MobileNumber": "73XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-2-202-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-2-202-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-2-202-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-2-202-1",
    "referenceID": 243085,
    "statusCode": 200
}
204
YOU Telecom · Network 2

YOU Dealer Recharge

Executes a YOU dealer-balance recharge.

NetworkNumber2
ServiceNumber204

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 2 Required The network identifier that owns the selected payment service.
ServiceNumber 204 Required The payment service identifier within the selected network.
TransactionID PAY-2-204-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge a dealer balanceRequest and response example

Recharge the selected YOU dealer account with the requested amount.

Request example 
{
    "NetworkNumber": 2,
    "ServiceNumber": 204,
    "MobileNumber": "73XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-2-204-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-2-204-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-2-204-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-2-204-1",
    "referenceID": 243085,
    "statusCode": 200
}
205
YOU Telecom · Network 2

YOU Open-Value Recharge

Recharges a YOU subscriber with an open value.

NetworkNumber2
ServiceNumber205

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 2 Required The network identifier that owns the selected payment service.
ServiceNumber 205 Required The payment service identifier within the selected network.
TransactionID PAY-2-205-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge an open valueRequest and response example

Recharge the subscriber with the requested number of units.

Request example 
{
    "NetworkNumber": 2,
    "ServiceNumber": 205,
    "MobileNumber": "73XXXXXXX",
    "Amount": 100,
    "TransactionID": "PAY-2-205-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-2-205-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-2-205-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-2-205-1",
    "referenceID": 243085,
    "statusCode": 200
}
206
YOU Telecom · Network 2

YOU Unified-Price Offer

Activates a supported YOU unified-price offer.

NetworkNumber2
ServiceNumber206

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 2 Required The network identifier that owns the selected payment service.
ServiceNumber 206 Required The payment service identifier within the selected network.
TransactionID PAY-2-206-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a unified-price offerRequest and response example

Activate the selected unified-price offer for the subscriber.

Request example 
{
    "NetworkNumber": 2,
    "ServiceNumber": 206,
    "MobileNumber": "73XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-2-206-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-2-206-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-2-206-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-2-206-1",
    "referenceID": 243085,
    "statusCode": 200
}
301
Sabafon · Network 3

Sabafon Charge Category

Recharges a Sabafon subscriber using a predefined category.

NetworkNumber3
ServiceNumber301

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 3 Required The network identifier that owns the selected payment service.
ServiceNumber 301 Required The payment service identifier within the selected network.
TransactionID PAY-3-301-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge using a charge categoryRequest and response example

Send the category value returned by the recharge-categories catalog.

Request example 
{
    "NetworkNumber": 3,
    "ServiceNumber": 301,
    "MobileNumber": "71XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-3-301-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-3-301-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-3-301-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-3-301-1",
    "referenceID": 243085,
    "statusCode": 200
}
302
Sabafon · Network 3

Sabafon Open-Value Recharge

Recharges a Sabafon subscriber with an open value.

NetworkNumber3
ServiceNumber302

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 3 Required The network identifier that owns the selected payment service.
ServiceNumber 302 Required The payment service identifier within the selected network.
TransactionID PAY-3-302-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge an open valueRequest and response example

Recharge the subscriber with the requested number of units.

Request example 
{
    "NetworkNumber": 3,
    "ServiceNumber": 302,
    "MobileNumber": "71XXXXXXX",
    "Amount": 100,
    "TransactionID": "PAY-3-302-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-3-302-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-3-302-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-3-302-1",
    "referenceID": 243085,
    "statusCode": 200
}
303
Sabafon · Network 3

Sabafon Bundle Offer

Activates the selected Sabafon bundle offer.

NetworkNumber3
ServiceNumber303

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 3 Required The network identifier that owns the selected payment service.
ServiceNumber 303 Required The payment service identifier within the selected network.
TransactionID PAY-3-303-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a Sabafon bundleRequest and response example

Activate the bundle selected from the available Sabafon offers.

Request example 
{
    "NetworkNumber": 3,
    "ServiceNumber": 303,
    "MobileNumber": "71XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-3-303-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-3-303-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-3-303-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-3-303-1",
    "referenceID": 243085,
    "statusCode": 200
}
304
Sabafon · Network 3

Sabafon Dealer Recharge

Executes a Sabafon dealer-balance recharge.

NetworkNumber3
ServiceNumber304

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 3 Required The network identifier that owns the selected payment service.
ServiceNumber 304 Required The payment service identifier within the selected network.
TransactionID PAY-3-304-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge a dealer balanceRequest and response example

Recharge the selected dealer account with the requested number of units.

Request example 
{
    "NetworkNumber": 3,
    "ServiceNumber": 304,
    "MobileNumber": "71XXXXXXX",
    "Amount": 100,
    "TransactionID": "PAY-3-304-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-3-304-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-3-304-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-3-304-1",
    "referenceID": 243085,
    "statusCode": 200
}
305
Sabafon · Network 3

Sabafon Postpaid Payment

Pays a supported Sabafon postpaid account.

NetworkNumber3
ServiceNumber305

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 3 Required The network identifier that owns the selected payment service.
ServiceNumber 305 Required The payment service identifier within the selected network.
TransactionID PAY-3-305-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Pay a postpaid accountRequest and response example

Pay the selected postpaid account using the requested payment units.

Request example 
{
    "NetworkNumber": 3,
    "ServiceNumber": 305,
    "MobileNumber": "71XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-3-305-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-3-305-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-3-305-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-3-305-1",
    "referenceID": 243085,
    "statusCode": 200
}
401
Y Telecom · Network 4

Y Telecom Charge Category

Recharges a Y Telecom subscriber using a predefined category.

NetworkNumber4
ServiceNumber401

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 4 Required The network identifier that owns the selected payment service.
ServiceNumber 401 Required The payment service identifier within the selected network.
TransactionID PAY-4-401-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge using a charge categoryRequest and response example

Send the category value returned by the recharge-categories catalog.

Request example 
{
    "NetworkNumber": 4,
    "ServiceNumber": 401,
    "MobileNumber": "70XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-4-401-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-4-401-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-4-401-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-4-401-1",
    "referenceID": 243085,
    "statusCode": 200
}
402
Y Telecom · Network 4

Y Telecom Bundle Offer

Activates the selected Y Telecom bundle offer.

NetworkNumber4
ServiceNumber402

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 4 Required The network identifier that owns the selected payment service.
ServiceNumber 402 Required The payment service identifier within the selected network.
TransactionID PAY-4-402-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a Y Telecom bundleRequest and response example

Activate the bundle selected from the available Y Telecom offers.

Request example 
{
    "NetworkNumber": 4,
    "ServiceNumber": 402,
    "MobileNumber": "70XXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-4-402-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-4-402-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-4-402-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-4-402-1",
    "referenceID": 243085,
    "statusCode": 200
}
403
Y Telecom · Network 4

Y Telecom Open-Value Recharge

Recharges a Y Telecom subscriber with an open value.

NetworkNumber4
ServiceNumber403

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 4 Required The network identifier that owns the selected payment service.
ServiceNumber 403 Required The payment service identifier within the selected network.
TransactionID PAY-4-403-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge an open valueRequest and response example

Recharge the subscriber with the requested number of units.

Request example 
{
    "NetworkNumber": 4,
    "ServiceNumber": 403,
    "MobileNumber": "70XXXXXXX",
    "Amount": 100,
    "TransactionID": "PAY-4-403-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-4-403-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-4-403-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 121,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-4-403-1",
    "referenceID": 243085,
    "statusCode": 200
}
502
Yemen Net ADSL · Network 5

ADSL Payment

Pays or recharges the requested ADSL account.

NetworkNumber5
ServiceNumber502

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 5 Required The network identifier that owns the selected payment service.
ServiceNumber 502 Required The payment service identifier within the selected network.
TransactionID PAY-5-502-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 01XXXXXX Required The ADSL subscriber account identifier.
Amount 1000 Required The monetary value to pay to the ADSL subscriber account.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Pay an ADSL accountRequest and response example

Pay the selected ADSL account using an amount accepted for that account.

Request example 
{
    "NetworkNumber": 5,
    "ServiceNumber": 502,
    "MobileNumber": "01XXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-5-502-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-5-502-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-5-502-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-5-502-1",
    "referenceID": 243085,
    "statusCode": 200
}
602
Landline · Network 6

Landline Payment

Pays the requested landline account.

NetworkNumber6
ServiceNumber602

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 6 Required The network identifier that owns the selected payment service.
ServiceNumber 602 Required The payment service identifier within the selected network.
TransactionID PAY-6-602-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 0XXXXXXX Required The landline subscriber number.
Amount 1000 Required The monetary value to pay to the landline subscriber number.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Pay a landline accountRequest and response example

Pay the selected landline account with the requested amount.

Request example 
{
    "NetworkNumber": 6,
    "ServiceNumber": 602,
    "MobileNumber": "0XXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-6-602-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-6-602-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-6-602-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-6-602-1",
    "referenceID": 243085,
    "statusCode": 200
}
702
Yemen 4G · Network 7

Yemen 4G Recharge

Recharges the requested Yemen 4G data account.

NetworkNumber7
ServiceNumber702

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 7 Required The network identifier that owns the selected payment service.
ServiceNumber 702 Required The payment service identifier within the selected network.
TransactionID PAY-7-702-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 10XXXXXX Required The Yemen 4G subscriber account identifier.
Amount 1000 Required The monetary value to recharge, pay, or use for the selected Yemen 4G service.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge a Yemen 4G data accountRequest and response example

Recharge the selected data account using an available value.

Request example 
{
    "NetworkNumber": 7,
    "ServiceNumber": 702,
    "MobileNumber": "10XXXXXX",
    "Amount": 2400,
    "TransactionID": "PAY-7-702-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-7-702-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-7-702-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-7-702-1",
    "referenceID": 243085,
    "statusCode": 200
}
703
Yemen 4G · Network 7

Yemen 4G Call Balance

Recharges the calling balance of a Yemen 4G account.

NetworkNumber7
ServiceNumber703

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 7 Required The network identifier that owns the selected payment service.
ServiceNumber 703 Required The payment service identifier within the selected network.
TransactionID PAY-7-703-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 10XXXXXX Required The Yemen 4G subscriber account identifier.
Amount 1000 Required The monetary value to recharge, pay, or use for the selected Yemen 4G service.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge Yemen 4G call balanceRequest and response example

Recharge the calling balance of the selected Yemen 4G account.

Request example 
{
    "NetworkNumber": 7,
    "ServiceNumber": 703,
    "MobileNumber": "10XXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-7-703-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-7-703-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-7-703-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-7-703-1",
    "referenceID": 243085,
    "statusCode": 200
}
704
Yemen 4G · Network 7

Change Yemen 4G Offer

Changes the active offer of a Yemen 4G account.

NetworkNumber7
ServiceNumber704

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 7 Required The network identifier that owns the selected payment service.
ServiceNumber 704 Required The payment service identifier within the selected network.
TransactionID PAY-7-704-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 10XXXXXX Required The Yemen 4G subscriber account identifier.
Amount 2400 Required The value of the available Yemen 4G offer to activate.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Change the active Yemen 4G offerRequest and response example

Select an available Yemen 4G offer by sending its corresponding value.

Request example 
{
    "NetworkNumber": 7,
    "ServiceNumber": 704,
    "MobileNumber": "10XXXXXX",
    "Amount": 2400,
    "TransactionID": "PAY-7-704-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-7-704-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-7-704-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 2400,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-7-704-1",
    "referenceID": 243085,
    "statusCode": 200
}
1402
Fiber Optic · Network 14

Fiber Optic Payment

Pays or recharges the requested fiber account.

NetworkNumber14
ServiceNumber1402

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 14 Required The network identifier that owns the selected payment service.
ServiceNumber 1402 Required The payment service identifier within the selected network.
TransactionID PAY-14-1402-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber FIBER-ACCOUNT-ID Required The fiber subscriber account identifier.
Amount 1000 Required The monetary value to recharge or pay to the fiber subscriber account.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Pay a fiber accountRequest and response example

Pay the selected fiber account using an amount accepted for that account.

Request example 
{
    "NetworkNumber": 14,
    "ServiceNumber": 1402,
    "MobileNumber": "FIBER-ACCOUNT-ID",
    "Amount": 6000,
    "TransactionID": "PAY-14-1402-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 6000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-14-1402-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 6000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-14-1402-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 6000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-14-1402-1",
    "referenceID": 243085,
    "statusCode": 200
}
1201
Sabafon South · Network 12

Sabafon South Charge Category

Recharges a Sabafon South subscriber using a predefined category.

NetworkNumber12
ServiceNumber1201

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 12 Required The network identifier that owns the selected payment service.
ServiceNumber 1201 Required The payment service identifier within the selected network.
TransactionID PAY-12-1201-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
Amount 1000 Required The number of recharge units. The platform multiplies this value by the configured unit price to calculate the final transaction price. For example, 10 units at a unit price of 1.21 produce a transaction price of 12.1.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Recharge using a charge categoryRequest and response example

Send the category value returned by the recharge-categories catalog.

Request example 
{
    "NetworkNumber": 12,
    "ServiceNumber": 1201,
    "MobileNumber": "7XXXXXXXX",
    "Amount": 1000,
    "TransactionID": "PAY-12-1201-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-12-1201-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-12-1201-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1210,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-12-1201-1",
    "referenceID": 243085,
    "statusCode": 200
}
1202
Sabafon South · Network 12

Sabafon South Bundle Offer

Activates the selected Sabafon South bundle offer.

NetworkNumber12
ServiceNumber1202

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 12 Required The network identifier that owns the selected payment service.
ServiceNumber 1202 Required The payment service identifier within the selected network.
TransactionID PAY-12-1202-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber 7XXXXXXXX Required The subscriber mobile number or the account identifier accepted by the selected service.
OfferCode OFFER_CODE Required The bundle or offer code returned by the corresponding catalog query.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Activate a Sabafon South bundleRequest and response example

Activate the bundle selected from the available Sabafon South offers.

Request example 
{
    "NetworkNumber": 12,
    "ServiceNumber": 1202,
    "MobileNumber": "7XXXXXXXX",
    "OfferCode": "OFFER_CODE_FROM_CATALOG",
    "TransactionID": "PAY-12-1202-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-12-1202-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-12-1202-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-12-1202-1",
    "referenceID": 243085,
    "statusCode": 200
}
1302
Aden Net · Network 13

Aden Net Payment

Pays or recharges the requested Aden Net account.

NetworkNumber13
ServiceNumber1302

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 13 Required The network identifier that owns the selected payment service.
ServiceNumber 1302 Required The payment service identifier within the selected network.
TransactionID PAY-13-1302-1 Required A unique transaction identifier that must not be reused for another payment.
MobileNumber ACCOUNT-ID Required The Aden Net subscriber account identifier.
Amount 1000 Required The monetary value to recharge or pay to the Aden Net subscriber account.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Pay an Aden Net accountRequest and response example

Pay the selected account using an amount accepted for that account.

Request example 
{
    "NetworkNumber": 13,
    "ServiceNumber": 1302,
    "MobileNumber": "ACCOUNT-ID",
    "Amount": 3000,
    "TransactionID": "PAY-13-1302-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 3000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-13-1302-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 3000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-13-1302-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 3000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-13-1302-1",
    "referenceID": 243085,
    "statusCode": 200
}
801
Games and Digital Content · Network 8

Game Top-up

Fulfills a supported game or digital product selected from the catalog.

NetworkNumber8
ServiceNumber801

The table below contains the complete request contract for this service.

Service-specific fieldsComplete request contract
FieldExampleRequiredDescription
NetworkNumber 8 Required The network identifier that owns the selected payment service.
ServiceNumber 801 Required The payment service identifier within the selected network.
TransactionID PAY-8-801-1 Required A unique transaction identifier that must not be reused for another payment.
LinkCode pubg_60 Required The product category code returned by the games and gift-card catalog.
Fields {"PlayerID":"PLAYER_ID"} Conditional A JSON-encoded string containing the field names and values required by the selected product category.
Quantity 1 Conditional Send the requested quantity only when the selected catalog product allows a free quantity, while observing its minimum and maximum.
Notes Optional payment note Optional An optional note attached to the submitted operation.
WebHookURL https://your-domain.com/webhook Optional The URL notified when the operation status changes.
WebHookCode xxxxxxxxx Optional Your verification value returned unchanged in the webhook.
Purchase a fixed productRequest and response example

Use the LinkCode and required fields returned by the selected fixed catalog product.

Request example 
{
    "NetworkNumber": 8,
    "ServiceNumber": 801,
    "LinkCode": "LINK_CODE_FROM_CATALOG",
    "Fields": "{\"PlayerID\":\"PLAYER_ID\",\"ZoneID\":\"ZONE_ID\"}",
    "TransactionID": "PAY-8-801-1",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-8-801-1",
    "referenceID": 243085,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-8-801-1",
    "referenceID": 243085,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-8-801-1",
    "referenceID": 243085,
    "statusCode": 200
}
Purchase a product with a free quantityRequest and response example

Send Quantity only when the selected catalog product allows it.

Request example 
{
    "NetworkNumber": 8,
    "ServiceNumber": 801,
    "LinkCode": "LINK_CODE_FROM_CATALOG",
    "Fields": "{\"PlayerID\":\"PLAYER_ID\"}",
    "Quantity": 100,
    "TransactionID": "PAY-8-801-2",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "Payment completed successfully.",
    "transactionID": "PAY-8-801-2",
    "referenceID": 243086,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation is pending.",
    "transactionID": "PAY-8-801-2",
    "referenceID": 243086,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 1000,
    "commission": 0,
    "commissionCurrency": null,
    "message": "The operation failed.",
    "transactionID": "PAY-8-801-2",
    "referenceID": 243086,
    "statusCode": 200
}
POST
Payment

Payment Manual Service

Access token required
Endpoint https://free-sadad.com/rest-api

Submit a manual service using its assigned ServiceNumber and required Fields. The response returns the operation status and charged price.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
FieldExample valueRequiredDescription
NetworkNumber10RequiredSelects the Manual Services network.
ServiceNumberAssigned service numberRequiredThe identifier assigned to the selected manual service. Use the value provided with its integration details.
FieldsJSON objectConditionalThe field names and values required by the selected service. Required fields and accepted formats vary by service.
TransactionIDMANUAL-1001RequiredYour unique transaction reference. Reuse it only when querying the status of the same operation.
WebHookURLhttps://your-domain.com/webhookOptionalStatus notification endpoint.
WebHookCodexxxxxxxxxOptionalYour webhook verification value.
Illustrative Fields object 
{
    "MobileNumber": "77XXXXXXX",
    "CustomerName": "Example Customer",
    "Quantity": 2
}
Request example 
{
    "NetworkNumber": 10,
    "ServiceNumber": "ASSIGNED_SERVICE_NUMBER",
    "Fields": {
        "MobileNumber": "77XXXXXXX",
        "CustomerName": "Example Customer",
        "Quantity": 2
    },
    "TransactionID": "MANUAL-1001",
    "WebHookURL": "https://your-domain.com/webhook",
    "WebHookCode": "xxxxxxxxx"
}
Completed response 
{
    "status": true,
    "operationStatus": 1,
    "agentBalance": 2445990.29131,
    "price": 2500,
    "message": "Payment completed successfully.",
    "transactionID": "MANUAL-1001",
    "referenceID": 243086,
    "commission": 0,
    "commissionCurrency": null,
    "statusCode": 200
}
Pending response 
{
    "status": true,
    "operationStatus": -1,
    "agentBalance": 2445990.29131,
    "price": 2500,
    "message": "The operation is pending.",
    "transactionID": "MANUAL-1001",
    "referenceID": 243086,
    "commission": 0,
    "commissionCurrency": null,
    "statusCode": 200
}
Failed operation response 
{
    "status": true,
    "operationStatus": 0,
    "agentBalance": 2445990.29131,
    "price": 2500,
    "message": "The operation failed.",
    "transactionID": "MANUAL-1001",
    "referenceID": 243086,
    "commission": 0,
    "commissionCurrency": null,
    "statusCode": 200
}
Rejected request response 
{
    "status": false,
    "message": "The request could not be accepted. Review the submitted fields and try again.",
    "statusCode": 400
}
Response fieldsPayment result envelope
FieldDescription
statusWhether the payment request was accepted. When true, read operationStatus for the payment outcome.
operationStatusThe operation state: 1 successful, 0 failed, or -1 pending.
agentBalanceThe agent account balance after the transaction.
priceThe price charged for the transaction.
commissionThe deferred commission value returned for the operation when available.
commissionCurrencyThe currency identifier of the returned commission, or null when no commission currency applies.
messageNotes or remarks describing the operation result.
transactionIDThe unique transaction identifier supplied by your system.
referenceIDThe transaction reference generated by the platform.
statusCodeThe HTTP status code represented in the response payload.
07
Tracking

Operation lifecycle

Interpret payment outcomes, track pending operations, and safely resolve uncertain results without submitting the same payment again.

Business outcome

Read operationStatus for every payment

operationStatusMeaningIntegration action
1CompletedRecord the operation as successful and keep its reference data.
-1PendingKeep the operation pending and query it later using the same TransactionID.
0FailedRecord the failure and use the returned message for the final reason.
POST
Tracking

Get Operation Status

Access token required
Endpoint https://free-sadad.com/rest-api

Check one operation using the same TransactionID originally supplied with the payment.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Request fieldsTracking service 2
FieldValueDescription
NetworkNumber0Operation-tracking network number.
ServiceNumber2Single operation-status service.
TransactionIDYour Transaction IDThe original transaction identifier supplied with the payment.
Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 2,
    "TransactionID": 1234
}
Completed operation response 
{
    "status": true,
    "operationStatus": 1,
    "mobileNumber": "777777777",
    "price": 100,
    "message": "جاهزة",
    "details": "Operation Notes",
    "transactionID": 1234,
    "referenceID": 4321
}
Pending operation response 
{
    "status": true,
    "operationStatus": -1,
    "mobileNumber": "777777777",
    "price": 100,
    "message": "في الانتظار",
    "details": "Operation Notes",
    "transactionID": 1234,
    "referenceID": 4321
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
POST
Tracking

Get Bulk Operation Status

Access token required
Endpoint https://free-sadad.com/rest-api

Check several submitted operations in one request using their original TransactionID values.

Request headers Required on protected requests
HeaderValuePurpose
api-tokenLogin access_tokenAuthenticates the API session.
Content-Typeapplication/jsonDeclares a JSON request body.
Acceptapplication/jsonRequests a JSON response.
Request fieldsTracking service 10
FieldValueDescription
NetworkNumber0Operation-tracking network number.
ServiceNumber10Bulk operation-status service.
TransactionIDs["TX-10001", "TX-10002"]A non-empty JSON array containing the original transaction identifiers.
Request example 
{
    "NetworkNumber": 0,
    "ServiceNumber": 10,
    "TransactionIDs": [
        "TX-10001",
        "TX-10002",
        "TX-10003"
    ]
}
Success response 
{
    "status": true,
    "data": {
        "TX-10001": {
            "operationStatus": 1,
            "message": "جاهزة",
            "details": "Payment completed",
            "price": 1000,
            "mobileNumber": "77XXXXXXX",
            "referenceID": 243085
        },
        "TX-10002": {
            "operationStatus": -1,
            "message": "في الانتظار",
            "details": "",
            "price": 500,
            "mobileNumber": "73XXXXXXX",
            "referenceID": 243086
        },
        "TX-10003": {
            "operationStatus": 0,
            "message": "Operation ID not found",
            "details": "",
            "price": 0,
            "mobileNumber": "",
            "referenceID": null
        }
    },
    "message": "Operation statuses fetched successfully (2 of 3).",
    "transactionID": 0
}
Error response 
{
    "status": false,
    "message": "Error Message"
}
08
Callbacks

Webhooks

Receive asynchronous operation-status updates through the callback URL supplied with a payment request.

Payment request fields

Provide callback details when creating the operation

FieldRequiredDescription
WebHookURLOptionalThe HTTPS endpoint that receives operation-status updates.
WebHookCodeOptionalYour verification value, returned unchanged with the callback.
Asynchronous updates

Webhook request

If WebHookURL is https://your-domain.com/webhook, the platform sends a GET request when the operation is updated.

Endpointhttps://your-domain.com/webhook
MethodGET
Parameters shown as JSON for clarity 
{
    "OperationStatus": 1,
    "WebHookCode": "xxxxxxxxx",
    "TransactionID": "TransactionID From Your System",
    "ReferenceID": 220065,
    "price": 507.87,
    "message": "Order Success"
}
Parameter descriptionsGET query string
ParameterDescription
OperationStatusOperation status: 0 failed or 1 completed.
WebHookCodeThe verification value supplied when the operation was created.
TransactionIDThe unique transaction identifier from your system.
ReferenceIDThe operation reference generated by the platform.
priceThe operation price charged to your account.
messageNotes describing the current operation result.
Actual GET request example 
curl -G "https://your-domain.com/webhook" \
--data-urlencode "OperationStatus=1" \
--data-urlencode "WebHookCode=xxxxxxxxx" \
--data-urlencode "TransactionID=TXN789" \
--data-urlencode "ReferenceID=220065" \
--data-urlencode "price=507.87" \
--data-urlencode "message=Order received and under process"
09
Outcomes

Responses and errors

The complete transport-status reference used by the API, including the situations in which each response can occur.

Standard HTTP response codes communicate whether the API could process a request. A 200 OK response indicates successful transport processing, while 4xx and 5xx responses describe client or server-side problems.

TransportHTTP statusCould the API accept and process the request?
Business resultstatusDid the requested business action succeed?
Payment resultoperationStatusIs the payment ready, failed, or pending?
1SuccessfulThe payment is ready.
-1PendingQuery the same TransactionID later.
0FailedRead the response message.
HTTPStatus and descriptionWhen it occurs
200 OKThe request was processed successfully.
  • A successful HTTP response still requires checking the JSON status boolean field to determine the business result.
400 Bad RequestMissing mandatory data or malformed request.
  • Required data is incomplete, such as OfferCode, NetworkNumber, or TransactionID.
  • A target identifier such as MobileNumber or PlayerID is missing.
  • The body is empty or contains invalid JSON.
401 UnauthorizedAuthentication failure.
  • The API Token is missing or incorrect.
  • The login signature is invalid.
  • The API session or access token has expired.
402 Balance Not EnoughInsufficient funds to perform the requested operation.
  • Your API account balance is lower than the transaction price.
  • Your API account does not have enough available balance for the requested query.
403 ForbiddenAccess denied due to account restrictions or permissions.
  • The targeted mobile number or identifier is restricted.
  • The requested service is not available to your API account.
  • The request is blocked by account or service access rules.
404 Not FoundThe requested resource or identifier does not exist.
  • The supplied OfferCode or ServiceNumber does not exist.
  • The requested TransactionID does not match an available operation.
406 Not AcceptableIncompatibility or incorrect data formatting.
  • The phone number prefix or length is invalid.
  • The PlayerID or target identifier is incompatible with the service.
  • The offer is not compatible with the subscriber line type.
416 Range Not SatisfiableThe requested value is outside the allowed range.
  • The transaction amount is below the allowed minimum.
  • The quantity or amount exceeds the maximum service limit.
423 LockedThe requested service or account is temporarily unavailable.
  • The selected service, category, or package is temporarily unavailable.
  • The package or offer is no longer available.
  • Access to the API account is temporarily suspended.
429 Too Many RequestsRate limits or overlapping requests.
  • The identifier exceeded its allowed query count within 24 hours.
  • Another operation for the same target is already in progress.
  • The account reached its daily order or concurrent-operation limit.
503 Service UnavailableThe requested service is temporarily unavailable.
  • The service is undergoing scheduled or emergency maintenance.
  • The service could not accept the request at this time.
  • Retry later or contact support if the response continues.