search

Payout

hashtag
Overview

The Rumbapay Payout API allows you to make payouts to your clients' bank accounts. This document provides instructions on how to create and manage bank transfer payouts.

How exactly Bank Transfer Payout works:

  1. Merchant makes a request to create a bank transfer payout;

  2. Rumbapay processes the payout, interacting with the appropriate banking provider;

  3. Rumbapay sends a webhook to the merchant once the transaction status becomes terminal.

Base URL:

  • https://api.rumbapay.online/v1/

Data Format: JSON

HTTP Methods: POST, GET

hashtag
Initialize Payout

Method: HTTP POST

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

Request Body:

{
    "method": "bank_transfer_uruguay", // required
    "mode": "initial", // required, only "initial" for this method
    "reference": "BankTransferUruguayPayout#1", // required, unique
    "currency": "UYU", // required
    "amount": 50, // required
    "description": "order payout", // optional,
    "customer":// required
    { 
        "identifier": "1234567890123456789012", // required, any unique value from the merchant's system may be used.
        "email": "juancarlos@hotmail.com", // conditional
        "phone": "+5491123456789", // conditional
        "first_name": "Juan", // required
        "last_name": "García Rodríguez", // required
        "middle_name": "Carlos", // optional
        "country": "UY", // required
        "state_code": "MO", // optional
        "city": "Montevideo", // optional
        "address": "Calle Emilio Mitre 3256", // optional
        "zip_code": "11200", // optional
        "itn": "12345678901", // required
        "birthday": "2006-01-22", // optional
        "ip": "192.168.0.1", // optional
        "gender": "male" // optional
    },
    "bank_transfer_uruguay": { // required
         "account_number": "1000296999931", // required
         "account_type": "CHECKING", // required, SAVINGS by default
         "bank_code": "0012", // required
         "beneficiary_first_name": "Darth", // required
         "beneficiary_last_name": "Veider", // required
         "beneficiary_email": "test@gmail.com", // required
         "beneficiary_phone": "+56221234567", // required
         "beneficiary_document_type": "CI", // required
         "beneficiary_document_value": "45678901"
    },
    "lang":"es",// optional
    "redirect_url": "redirect_url", // optional
    "cancel_url": "cancel_url", // optional
    "callback_url": "callback_url", // conditional
    "extra":  // any field which may be needed for transaction routing and integration
    [
        {"key_1":"value"},
        {"key_2":"value"}
    ]
}

Response (Success):

hashtag
Response - 400 Bad request

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 payout request

  2. When the payout 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 Payout Status

Method: HTTP GET

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

Response (Success):

hashtag
Response (Not Found):

Transaction not found

PreviousBank Transfer UruguayNextEcuador

Last updated