Web Checkout

Accepting Payments via Web Checkout

Our Web Checkout integration option is best used for accepting payments through websites, but can also be used in mobile applications as a webview. To use our Web Checkout you simply need to generate a payment link and redirect your users there so they can complete payment. Below is an example of how to generate a payment link using our API:

Before you begin, make sure you understand the difference between Test and Live Mode as this will affect how your integration works.

Security and Compliance

Our Web Checkout solution is built with security as a priority, following guidelines from:

• Mozilla's Web Security Guidelines
• OWASP's Secure Coding Practices
• W3C's Payment Request API Standards

For more advanced integration needs, you might want to consider our Direct API which provides more control over the payment process.

One-Time Payment

Use this endpoint to generate a payment link for a single, one-time payment transaction.

HTTP Method: POST

Authorization: Pass your authorization token (Which you can find in the dashboard) as a bearer token in the header.

Header:
{
  "Authorization": "Bearer <Authorization-Token>"
}

Body:
{
  "amount": 15,
  "paymentSuccessfulRedirectUrl": "https://your-successful-redirect-url",
  "paymentFailedRedirectUrl": "https://your-failed-redirect-url",
  "clientReferenceId": "7ff632fc-3e5b-4be5-b2a0-dbe2600e7789",
  "description": "Test payment",
  "commissionPaidByCustomer": false // Optional: pass commission fees to customer (default: false)
}

{
  "responseCode": "0",
  "responseMessage": "Success",
  "currentDate": "2025-06-22",
  "currentTime": "13:25:20",
  "paymentUrl": "https://gateway.yallapaysudan.com/checkout/web/01JXF7HSW4P9FCG9YN6Z"
}

Subscription Payment

Use this endpoint to generate a payment link for recurring subscription payments.

HTTP Method: POST

Authorization: Pass your authorization token (Which you can find in the dashboard) as a bearer token in the header.

Header:
{
  "Authorization": "Bearer <Authorization-Token>"
}

Body:
{
  "amount": 15,
  "paymentSuccessfulRedirectUrl": "https://your-successful-redirect-url",
  "paymentFailedRedirectUrl": "https://your-failed-redirect-url",
  "clientReferenceId": "7ff632fc-3e5b-4be5-b2a0-dbe2600e7789",
  "description": "Test subscription payment",
  "commissionPaidByCustomer": false, // Optional: pass commission fees to customer (default: false)
  "subscriptionConfiguration": {
      "interval": "MONTH", // Accepted values are DAY, MONTH, YEAR
      "intervalCycle": "2", // Every 2 intervals (e.g., months or days)
      "totalCycles": "10" // Optional. This is the total number of recurring payments to be made. If left null then the default is infinite (never ending subscription)
  }
}

• subscriptionConfiguration is required for subscription payments.
• Field requirements inside subscriptionConfiguration:
  • interval: Required (Accepted values: DAY, MONTH, YEAR)
  • intervalCycle: Required (e.g., 2 means every 2 intervals)
  • totalCycles: Optional — if omitted, the subscription continues indefinitely

{
  "responseCode": "0",
  "responseMessage": "Success",
  "currentDate": "2025-06-22",
  "currentTime": "13:25:20",
  "paymentUrl": "https://gateway.yallapaysudan.com/checkout/web/01JXF7HSW4P9FCG9YN6Z"
}

Best Practices for Web Checkout

When implementing our Web Checkout, consider these best practices:

1. Secure Redirects: Follow Google's Web Fundamentals guide on Navigation and Redirects to ensure secure redirects.
2. User Experience: Design your payment flow according to Nielsen Norman Group's checkout usability guidelines.
3. Mobile Optimization: Ensure your checkout process is mobile-friendly as recommended by Google's Mobile-Friendly Test.

For a comprehensive overview of how our payment system works, check out our System Overview documentation.