YallaPay - Documentation

Payments through API (Demo with Postman)

Generate a checkout link directly from your backend. Send the request below with your merchant credentials and the system returns a hosted checkout URL you can redirect the customer to.

Endpoint

POST Generate checkout link to make a payment

https://yallapay.net/api/request

Headers

Accept	application/json
Content-Type	application/json

Request Body

BODY formdata

private_key	Merchant_private_key
currency	Merchant_currency
is_fallback (optional)	Accept(1 OR 0) 1 = It will return fallback URl. 0 = It willn't return fallback URl.
fallback_url (conditional)	http://domain.com/status is_fallback = 1 then it will require.
external_id (int)	Merchant_external_id, you can use it for your product id or any custom id.
amount	100
purpose	Test payment
bill_to (optional)	Customer / payer name shown on the checkout page (e.g. John Doe).
fee_payer (optional)	Who pays the YallaPay processing fee. Accepts merchant or customer. merchant (default) — the fee is deducted from your settlement. customer — the fee is added on top of the amount at checkout, so you receive the full amount and the customer pays the fee.
store_id (optional)	12345 (Generate store id from webhook page)

In body add private_key, currency, is_fallback, url, amount as keys with their values from the credentials of merchant profile.

cURL Example

curl -X POST "https://yallapay.net/api/request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "private_key": "YOUR_PRIVATE_KEY",
    "currency": "AED",
    "amount": 100,
    "external_id": 12345,
    "purpose": "Test payment",
    "bill_to": "John Doe",
    "fee_payer": "customer",
    "is_fallback": 1,
    "fallback_url": "https://yoursite.com/status",
    "store_id": "12345"
  }'

Response

On success, you receive a checkout URL. Redirect the customer there to complete payment.

{
  "status": "success",
  "checkout_url": "https://yallapay.net/checkout/abc123xyz",
  "request_id": "abc123xyz"
}

Visual Walkthrough

The checkout_url opens the hosted checkout below. It carries your business name, the purpose you sent, the amount in AED, Apple Pay / Google Pay and the card form — nothing to build or style on your side.

Checkout Page:

After the payment

When you send is_fallback: 1, the customer is returned to your fallback_url with the outcome appended as query parameters:

https://yoursite.com/status
   ?status=success
   &trxid=07071234567890123456
   &external_id=12345
   &payment_method=card
   &getway=…
   &signature=3c9e…

Parameters

status	`success` or `failed`.
trxid	The transaction id, when there is one.
external_id	The id you sent when you created the link.
payment_method	`card`, `apple_pay` or `google_pay`.
getway	Deprecated. Ignore it; it will be removed.
signature	HMAC over the other parameters, so you can prove they came from us.

A redirect is not a receipt.

Anyone can open a URL with status=success. Verify the signature on your server, and mark the order paid from the webhook or from the verify endpoint — never from the redirect alone.

Keep your private key secret

Never expose your private key in client-side code or public repositories. Always make this API call from your backend server.

Verify Payment