BomaPay Documentation

BomaPay API documentation covering payment partners, integration flows, authentication, API endpoints, and SDKs.

← Back to projects

Redirect Integration

Redirect integration is a simple and secure process that uses the payment page on the payment gateway side. The main advantage of this integration method is that you don't need to collect and process card data on your website. The API is used minimally in this case, so this method does not require much development expertise.

Documentation image

Steps

  1. A customer selects a product in the online store, and then clicksBuy.
  2. The online store server receives a purchase request.
  3. The online store server requests an order registration by sending theregister.doAPI call to the payment gateway. This request must contain theamountparameter (the payment amount in minor currency units) and thereturnUrlparameter (the address to which the customer will be redirected after successful payment in step9). Read more about redirect after paymenthere.
  4. The payment gateway server registers an order and sends a response to the online store server. The response contains theformUrlparameter (the payment URL to which the online store should redirect the customer in step5) and theorderIdparameter (the unique order number in the payment gateway system, will be used in step10).
  5. The online store redirects the customer to the URL received in theformUrlparameter. The redirection may be done in the same window or in a new window.
  6. The payment gateway opens the payment URL.
  7. The customer enters his or her card number, expiration date, and CVV/CVC, and clicksPay.

In this case the customer selects the corresponding option.

  1. The payment gateway processes the payment request.
  2. The customer is redirected to the online store page defined in thereturnUrlparameter (specified in step3).
  3. The online store sends thegetOrderStatusExtended.dorequest to the payment gateway to check the order status and make sure the order is really paid. The request contains theorderIdparameter received in step4. In response, the payment gateway returns the order status in theorderStatusparameter. Status2means a succesfull payment. Additionally, theactionCodeparameter is returned - it contains the response code from the processing bank.