search

Payment

hashtag
Overview

Rumbapay provides two options for processing payment requests: redirection to the Rumbapay payment page (HPP) and direct server-to-server communication (H2H). When creating a payment using the method https://api.rumbapay.online/v1/payment you must inspect the challenge.challenge_type field to determine the appropriate flow.

Base URLs: https://api.rumbapay.online/v1/

Data Format: JSON

HTTP Methods: POST, PUT, GET

hashtag
Create payment API

hashtag
Initialize Payment

When creating a payment using the method https://api.rumbapay.online/v1/payment you must inspect the challenge.challenge_type field to determine the appropriate flow.

Method: HTTP POST

URL: https://api.rumbapay.online/v1/payment

circle-check

Initialize Payment request (request body) can take two forms.

The system accepts and processes both types of requests. Requests are handled identically, regardless of the request body format.

Request Body Type H2H:

{
    "reference": "AfricaBankTransferH2H#1", // required, unique
    "currency": "NGN", // required
    "amount": 876, // required
    "description": "My order h2h", // optional
    "customer":// required
    { 
    	"identifier": "1111-1111-2211-2211", // required, any unique value from the merchant's system may be used.
    	"email": "juancarloos@hotmail.com", // required
    	"phone": "+2348031234567", // optional, Nigerian format number 
    	"first_name": "Juan", // required
    	"last_name": "Garcisa Rodriiguez", // required
    	"middle_name": "Carlos", // optional
    	"country": "NG",  // optional, Nigeria (ISO 3166-1 country code for Nigeria)
    	"state_code": "B",  // optional
    	"city": "Buenos Aires", // optional
    	"address": "Calle Emilio Mitre 3256", // optional
    	"zip_code": "C1407", // optional
    	"itn": "2526232527",  // conditional
    	"birthday": "2006-01-02", // optional
    	"ip": "192.168.0.1", // optional
    	"gender": "male" // optional
    },
    "method": "bank_transfer_africa", //required
    "redirect_url": "redirect-url", // optional
    "cancel_url": "cancel_url", // optional
    "callback_url": "callback_url", // conditional
    "extra":  // conditional, any field which may be needed for transaction routing and integration
        [
            {"key_1":"value"},
            {"key_2":"value"},
            {"key_3":"value"},
            {"key_4":"value"}
        ]
}

Request Body Type HPP:

circle-info

💡The payment process depends on challenge_type parameter received

REQUISITES Payment Flow:

  1. Merchant sends a payment request to https://api.rumbapay.online/v1/payment

  2. Rumbapay validates the request and returns payment details including:

    • Bank account information for the customer to make the payment

    • Required form fields the merchant must collect from the customer

  3. Customer makes the payment using the provided bank information

  4. Merchant collects payment confirmation details from the customer (transaction ID, etc.)

  5. Merchant sends confirmation data to https://api.rumbapay.online/v1/payment/{request_id}

  6. Rumbapay processes the payment confirmation and updates the status to "pending"

  7. Rumbapay verifies the payment with the banking provider

  8. Rumbapay sends a callback to the merchant's callback URL when the payment reaches a terminal state (success, error, etc.)

REDIRECT Payment Flow:

  1. Merchant sends a payment registration request to https://api.rumbapay.online/v1/payment

  2. Rumbapay validates the request and returns a redirect_url for the customer

  3. Merchant redirects the customer to the provided redirect_url, where a payment form will be displayed

  4. Customer fills out the payment form with the required details

  5. Customer submits the form directly to Rumbapay or Payment provider

  6. Rumbapay or provider processes the submission and updates the payment status to "pending"

  7. If a redirect_url was specified in the initial registration request, Rumbapay redirects the customer to that URL; otherwise, Rumbapay displays its own status page to the customer

  8. Rumbapay verifies the payment with the banking provider

  9. Rumbapay sends a callback to the merchant's callback URL when the payment reaches a terminal state (success, error, etc.)

  10. Additionally, the merchant can check the payment status at any time by sending a request to https://api.rumbapay.online/v1/transaction/{request_id} as described in the "Check Payment Status" section

Response (Success):

Response - 200 OK

  1. First, you should check error_code field of response.

    If error_code field is not equals to 0 - transaction is Failed.

  2. Second, you should check status field.

    The status field will always be set to created if there are no errors.

    Make check request or wait for a callback to get final transaction status.

hashtag
Challenge type: redirect

circle-info

💡 If the challenge.challenge_type is set to redirect, you must send your Customer to the URL specified in challenge.challenge_redirect.url.

hashtag
Challenge type: requisites

circle-info

If the challenge.challenge_type is requisites, prompt the user to make a payment using the details in challenge_form.payment_information and confirm the payment by sending the information to https://api.rumbapay.online/v1/payment/{request_id}arrow-up-right.

hashtag
Response - 400 Bad request

hashtag
Callback

On every completed Payment we send a callback notification to the URL you passed in the request in the callback_url field.

circle-exclamation

We strongly recommend validating the callback signature to avoid suspicious activity. Follow the signature docs to prepare callback verification.

hashtag
Callback flow

The callback flow follows these steps:

  1. Rumbapay processes the payment request

  2. When the payment status changes to a terminal state, Rumbapay sends an HTTP POST request to your callback URL

  3. Your server should process the callback, validate the signature, and update your system

  4. Your server should respond with HTTP 200 OK to acknowledge receipt

hashtag
Example

hashtag
Check Payment Status

Method: HTTP GET

URL: https://api.rumbapay.online/v1/transaction/{request_id}

Response (Success):

hashtag
Response (Not Found):

Transaction not found

PreviousBank Transfer AfricaNextPayout

Last updated