Skip to content

How to create check form

This guide explains how to build a form in your website that collects customer payment info and calls:

GET /api/payment_link_check

Required form fields

Minimum:

  • phone: sender phone number
  • amount: amount sent

Also send:

  • user_name: customer username in your system
  • store_id: your store ID in our system
  • lang: ar or en

Request shape

http
GET /api/payment_link_check?phone=01000000000&amount=100&user_name=customer_001&store_id=2&lang=en

Frontend example (JavaScript)

js
const params = new URLSearchParams({
  phone,
  amount,
  user_name,
  store_id,
  lang: 'en',
})

const res = await fetch(`/api/payment_link_check?${params.toString()}`)
const body = await res.json()

Response handling

Success

json
{
  "status": true,
  "requires_verification": false
}

Action:

  • Show payment success.
  • Continue your business action.

Normal failure (no matching transaction)

json
{
  "status": false,
  "message": "No matching transaction found"
}

Action:

  • Show clear error.
  • Allow retry.

Anti‑Spam case (waiting-for-approval)

json
{
  "status": false,
  "requires_verification": true,
  "pending_verification": true,
  "flow_state": "waiting-for-approval"
}

Action:

  • Tell user request is under review.
  • Do not treat this as final failure.
  • Ask user to retry later after manual approval.