Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

Countries and regions Bolivia (Plurinational State of Bolivia)
Payment currencies BOB
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Payout by using Gate

General information

To perform a payout by using Gate with the Bank transfers in Bolivia payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the Bank transfers in Bolivia payment method.

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service informs the payment platform about the payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Bank transfers in Bolivia payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/bank-transfer/bolivia/payout
Full API endpoint specification /v2/payment/bank-transfer/{payment_method}/payout
Table 1. Basic parameters of a payout request

strictly required—the parameter must be in the initial request.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

identify
object
strictly required

doc_number
string
strictly required

Identity document number.

Example: 12345678901

doc_type
string
strictly required

Type of an identity document.

Possible values:

  • CI—for the number of ID card (Cédula de Identidad)
  • CEX—for the number of foreigner ID card (Cédula de Identidad de Extranjero)
  • PAS—for the passport number (Pasaporte)
  • OD—for the number of another identification document (Otro Documento de Identidad)
  • NIT—for the unique taxpayer number (Número de Identificatión Tributaria)

Example: CI

account
object
strictly required

number
string
strictly required

Customer's account number.

Example: 1234567890

type
string
strictly required

Customer's account type.

Possible values:

  • CACC—for the current account
  • SVGS—for the savings account

Example: SVGS

bank_id
integer
strictly required

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout.

Example: 75542

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: BOB

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 BOB must be sent as 10000

You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the Bank transfers in Bolivia payment method:

Figure 2. Example of the payout request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "identify": {
            "doc_number": "12345678901",
            "doc_type": "CI"
        }
    },
    "account": {
        "number": "1234567890",
        "type": "SVGS",
        "bank_id": 75542
    },
    "payment": {
        "currency": "BOB",
        "amount": 10000
    }
}

Callback

In the Bank transfers in Bolivia payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed payout.

Figure 3. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Bolivia",
        "sum": {
            "amount": 10000,
            "currency": "BOB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "BOB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "BOB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined payout.

Figure 4. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Bolivia",
        "sum": {
            "amount": 10000,
            "currency": "BOB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "BOB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "BOB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Payout by using Dashboard

To make a payout through Dashboard, your system sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
  • as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Banks available for payout

Supported banks

In the Bank transfers in Bolivia payment method, payments are performed through the banks the payment method supports. For the payout to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for payout in the Bank transfers in Bolivia payment method.

Table 2. Banks available for payout
BankID
1 de Septiembre Ltda.78852
2 de Junio Abasto Ltda78702
4 de Agosto Ltda.78842
Alalay Ltda.78862
Almacenes Internacionales S.A.78672
Andrés Ibáñez Ltda.78872
Argenper Bolivia S.R.L.78622
Banco BISA75626
Banco de Crédito de Bolivia75542
Banco de la Nacían Argentina75936
Banco do Brasil75616
Banco Ecofuturo75896
Banco Economico75646
Banco Fassil75886
Banco FIE75876
Banco Fortaleza75906
Banco Ganadero75666
BANCO MERCANTIL SANTA CRUZ S.A78682
BANCO MERCANTIL74552
Banco Nacional de Bolivia75606
Banco para el Fomento a Iniciativas Económicas S.A.78552
Banco Pyme de la Comunidad75866
BANCO PYME LOS ANDES PROCREDIT S.A.78532
Banco Solidario75656
Banco Union75636
Billetera Movil de Entel75956
Caceres Ltda78632
Cantera Ltda.78882
Compañia Interamericana de Servicios S.R.L.78642
Concordia Ltda78892
Cooperativa Catedral75846
Cooperativa Comarapa75806
Cooperativa Educadores Gran Chaco75836
Cooperativa El Chorolque75826
Cooperativa Fatima75726
Cooperativa Jesus Nazareno75706
Cooperativa La Merced75926
Cooperativa Loyola75746
Cooperativa PIO X75766
Cooperativa Quillacollo75776
Cooperativa San Antonio75756
Cooperativa San Jose de Punata75786
Cooperativa San Martin75716
Cooperativa San Mateo75816
Cooperativa San Pedro75736
Cooperativa Trinidad75796
Cooprole Ltda.78712
Credicoop Ltda78902
Crédito Abierta Jesús Nazareno Ltda79112
Credito con Educacion Rural Institucion Financiera de Desarrollo (CRECER IFD)78562
Cristo Rey Ltda.78722
Diaconia IFD78572
El Buen Samaritano Ltda.78732
El Churqui Ltda78742
El Cristo Ltda78912
EMPETROL Ltda78752
EUROENVIOS S.R.L78662
FONDECO IFD78582
FUBODE IFD78592
Gran Grigotá Ltda.78762
Hospicio Ltda.78922
Ibercoop Ltda78932
IDEPRO IFD78602
IMPRO IFD78612
Institución Financiera de Desarrollo CIDRE78542
Institucion Financiera de Desarrollo75916
Jerusalén Ltda.78942
La Primavera Ltda.78952
La Sagrada Familia Ltda.78772
Magisterio Rural de Chuquisaca Ltda.78782
Magisterio Rural75856
More Bolivia S.A78652
Multiactiva Santiago de Munaypata Ltda79102
Mutual el Progreso75696
Mutual la Primera75676
Mutual la Promotora75686
Nuestra Señora de Los Remedios Ltda.78792
Paulo VI Ltda.78962
Perú Services S.R.L78692
Piraí Ltda78972
Reyes Ltda.78982
Sacarosa Ltda.78802
San Bartolomé Ltda78992
San Francisco de Asís Ltda.79002
San Francisco Solano Ltda.78812
San Gabriel Ltda.79012
Sarco Ltda78822
Señor de Burgos Ltda.79022
Solucredit San Silvestre79032
Terracoop Ltda.79042
Tigo Money75946
Tukuypaj Ltda.78832
Varsa Ltda.79052
Vía y Obras Ltda.79062
Vinto Ltda.79072
Virgen de los Remedios Ltda79082
Virgen de Urkupiña Ltda.79092
YAPE79122

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Bank transfers in Bolivia payment method supports, send a request to the payment platform.

Request for the list of available banks

The list of banks may change that's why we recommend that you send the payment platform a request for the list of banks currently available in the Bank transfers in Bolivia payment method. The request format and structure should be the following:

HTTP request method POST
Request body format JSON
API endpoint /v2/info/banks/bank-transfer/bolivia/payout/list
Full API endpoint specification /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list
Table 3. Parameters required in the request to get the list of banks available in the payment method

strictly required—parameter is required in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

 Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

 Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

 Signature created after you specify all the required parameters. For more information about, signature generation, see Signature generation and verification.

payment
object
strictly required

amount
integer
strictly required

 Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 BOB must be sent as 10000

currency
string
strictly required

 Code of the payout currency in the ISO-4217 alpha-3 format.

Example: BOB
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request for the list of banks available in the Bank transfers in Bolivia payment method.

Figure 5. Example of the data from the request for the list of available banks
{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "BOB"
    }
}
Figure 6. Example of the response with the list of banks available in the payment method
[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "BOB", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "BOB", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]