search

Payment

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
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: Type 1 and Type 2

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

Request Body Type H2H:

{
    "method": "skrill", // required
    "mode": "initial", // required, only "initial" for this method
    "reference": "SkrillH2HTestTransaction1", // required
    "currency": "EUR", // required
    "amount": 25.01, // 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": "joaosilva@hotmail.com", // optional
        "phone": "+5511987654321", // optional
        "first_name": "João", // required
        "last_name": "Silva", // required
        "middle_name": "Pereira", // optional
        "country": "FI",  // required, Finland(ISO 3166-1 country code for Finland)
        "state_code": "SP",  // optional, São Paulo (ISO 3166-2 state code for São Paulo)
        "city": "São Paulo", // optional
        "address": "Avenida Paulista 1578", // optional
        "zip_code": "01310-200", // optional
        "itn": "12345678900",  // optional
        "birthday": "1985-04-12", // optional
        "ip": "192.168.0.1", // optional
        "gender": "male" // optional
    },
    "redirect_url": "redirect_url", // optional
    "cancel_url": "cancel_url", // optional
    "callback_url": "callback_url", // optional
    "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

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
Callback

On every completed Payout 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

PreviousSkrillNextBelgium

Last updated