search

Payment

Overview

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

Request Body Type HPP:

{
  "reference": "{{$guid}}", // required
  "currency": "EUR", // required
  "amount": "15.23", // required
  "description": "description", // optional
  "customer": {
    "identifier": "12345", // // required, may be used any unique value from system of merchant
    "email": "user@example.com", // required
    "first_name": "Darth", // optional
    "last_name": "Vader", // optional
    "middle_name": "Skywalker", // optional
    "phone": "+522299377223", // optional
    "itn": "X1234567890", // optional
    "country": "CO", // required, ISO 3166-1
    "state_code": "DC", // optional, ISO 3166-2
    "city": "Bogotá", // optional
    "address": "Carrera 7 # 32-55", // optional
    "zip_code": "110311", // required
    "birthday": "2006-01-02", // required
    "ip": "192.168.0.1", // optional
    "gender": "male" // optional
  },
  "widget": {
    "method": "bancontact", // required
    "locale": "en" // optional
  },
  "redirect_url": "https://merchant.domain/pending", // optional
  "callback_url": "https://merchant.domain/callback", // conditional
  "cancel_url": "https://merchant.domain/cancel", // 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 H2H:

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.

If you get challenge.challenge_type with value redirect then you should redirect your Customer to the URL in the field challenge.challenge_redirect.url.

After the Customer successfully completes the challenge flow on our partner's page, they will be automatically redirected to the URL specified in the redirect_url field of your request.

hashtag
Response - 400 Bad request

If incorrect values are provided for widget.method or currency, you may receive the following response:

hashtag
Callback

We send a callback notification to the URL you passed in the transaction request in the callback_url field on every completed transaction.

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

PreviousBancontactNextBank Transfer

Last updated