Documentation

English

العربية

English

العربية

Appearance

Store setup (beginner-friendly) ​

If this is your first time using the service, this page gives you the exact starting steps.

First step: create your account ​

  1. Open vodafoncash.com.
  2. Sign up for a new account.
  3. Verify your account and log in.

After login, you have a tenant account where you can create and configure your store.

What is a Store? ​

A Store is your main integration profile that links:

  • Your website/system
  • Currency and rate settings
  • Your callback endpoint
  • Integration identifiers (store_id, API Token)

What is store_id? ​

store_id is your store identifier in our system. Your website sends it in API requests so our backend knows which store the request belongs to.

In short: wrong or missing store_id means matching/verification will fail.

What is API Token and how do I create it? ​

API Token is your auth key used for callback/provider-side verification based on your store integration type.

In practice, this key is used to verify trusted completion/callback or provider-side requests, depending on how your store is configured.

Steps:

  1. Open Integration/API settings in your account.
  2. Create a new API token.
  3. Store it securely (never expose it in frontend client code).

How it is sent depends on integration/provider type (header or query parameter).

payment_link_check is the core verification endpoint.

It does the following:

  • Receives phone + amount + store_id + user_name from your website.
  • Searches transactions received from the mobile app.
  • If it finds a match, it converts the transaction from pending to completed.

Example request:

GET /api/payment_link_check?phone=...&amount=...&user_name=...&store_id=...&lang=en

Website type: WordPress ​

If your site runs WordPress with our official plugin, choose Website type → WordPress when creating or editing a store:

  • Download the plugin from GitHub Releases (repository); full steps are in the WordPress integration guide.
  • A short help panel appears with a link to the WordPress integration guide.
  • The API URL field uses the WordPress REST callback shape (https://example.com/wp-json/vodafoncash/v1/callback) as the placeholder, and if the field is empty it is filled with that example so you can edit in your real hostname (or paste the URL copied from the plugin’s settings page).

WordPress uses the same completion request as Custom (GET with key, action=addPayment, etc.); the separate type only helps the dashboard guide you to the right docs and default URL.

Store settings you must complete ​

Inside your store settings, configure:

  • Basic store details
  • store_id
  • API Token
  • Callback endpoint in your website (where we send completion request) — see guide: How to create callback endpoint
  • Currency/rate settings

Quick checklist before moving on ​

Before opening Understand flow, make sure you have: