Payments API Documentation

Overview

The Yalla System API provides a complete programming interface for managing payments. It supports payments via Fawry, Wallet, and Visa.

Authentication

All requests require an API key in the Authorization header. Use the format: Bearer YOUR_API_KEY

Authorization: Bearer YOUR_API_KEY

4. External Endpoints

POST

/api/v1/payments

1. Create Transaction

Create a new payment transaction

GET

/api/v1/payments/:id/status

2. Transaction Status

Check transaction status

GET

/api/v1/payments

3. Query Transactions

List transactions with filtering

4. External Endpoints

Subscription Data

Fetch Payment Scope

POST

/api/v1/payments/fawry

5.1 Fawry Payment

Create Fawry payment

POST

/api/v1/payments/wallet

5.2 Wallet Payment

Create wallet payment

POST

/api/v1/payments/visa

5.3 Visa Payment

Create Visa payment session

// Create a Fawry payment
const payment = await yallaSystem.createPayment({
  amount: 1500.00,
  currency: 'EGP',
  method: 'fawry',
  customer: {
    name: 'Ahmed Hassan',
    email: '[email protected]'
  }
});

// Process the payment
const result = await payment.process();
console.log(result.status);        // 'success'
console.log(result.transactionId); // 'TXN_123456'

Ready to Get Started?

Get Started