Bank transfers in Bolivia
Overview
Bank transfers in Bolivia, a popular payment method in Bolivia, offers your customers a convenient way of paying for your services and receiving payouts. In the Bank transfers in Bolivia payment method, customers make purchases by using bank transfers. With Bank transfers in Bolivia, you can accept payments from your customers by using Payment Page and Gate and perform payouts by using Gate and Dashboard. Download the logo in the vector format here. |
Payment method type | Bank transfers |
---|---|
Countries and regions | Bolivia (Plurinational State of Bolivia) |
Payment currencies | BOB |
Currency conversion | On the Monetix side |
Purchases | |
Payouts | |
Stored credentials payments | |
Full refunds | |
Partial refunds | |
Chargebacks | |
Special considerations |
|
Onboarding and access fee | Contact your key account manager at Monetix for details. |
Operations support
Interfaces | Payment amount, BOB | Payment processing time | |||||
---|---|---|---|---|---|---|---|
Payment Page | Gate | Dashboard | minimum | maximum | basic | threshold | |
Purchase | 1.00 | 1,000,000.00 | 5 minutes | 48 hours | |||
Payout | 1.00 | 1,000,000.00 | 1-3 days | 35 days |
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.
Purchase by using Payment Page
General information
To perform a purchase by using Payment Page with the Bank transfers in Bolivia payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept the callback with the purchase result from the payment platform.
The following figure shows the complete purchase processing flow in the Bank transfers in Bolivia payment method.
- The customer initiates a purchase in your system.
- Your system sends the request for the purchase through Payment Page to the Monetix URL.
- The Monetix payment platform receives the request.
- The payment platform processes the request and checks whether it contains all the required parameters and the signature is correct.
- The payment platform creates the checkout page based on the project settings and request parameters.
- The checkout page is displayed to the customer.
- The customer chooses to make a purchase with the Bank transfers in Bolivia payment method.
- Payment Page forwards the purchase request to the payment platform.
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the purchase request.
- The provider service sends the customer redirection data to the payment platform.
- The payment platform forwards the data to Payment Page.
- Payment Page redirects the customer to the provider service.
- The customer completes the purchase.
- The provider service processes the purchase.
- The payment result is displayed to the customer in the provider service.
- The customer is redirected back to the checkout page.
- The provider service sends the purchase result information to the payment platform.
- The payment platform sends a callback with the payment result to your system.
- The payment platform sends the payment result to Payment Page.
- Payment Page displays the payment result to the customer on the checkout page.
Request
The following table lists the parameters that you need to include in the request for purchase through Payment Page with the Bank transfers in Bolivia payment method.
|
||
---|---|---|
Parameter | Description | |
project_id |
Project ID you obtained from Monetix when integrating. Example: |
|
payment_id |
Payment ID unique within your project. Example: |
|
customer_id |
Unique ID of the customer within your project. Example: |
|
customer_first_name |
Customer's first name. Example: |
|
customer_last_name |
Customer's last name. Example: |
|
customer_email |
Customer's email. Example: |
|
payment_currency |
Code of the purchase currency in the ISO-4217 alpha-3 format. Example: |
|
payment_amount |
Purchase 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 |
|
identify_doc_number |
The number of the document proving your customer's identity. Example: |
|
identify_doc_type |
The type of the document proving your customer's identity. Possible values:
Example: |
|
customer_account_number |
Customer's account number. Example: |
|
account_type |
Customer's account type. Possible values: CACC —for current account, SVGS —for savings account.Example: |
|
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | |
force_payment_method |
Parameter that allows you to enforce the Bank transfers in Bolivia payment method for your customer and skip the page with payment method selections. To enforce the Bank transfers in Bolivia payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to Example: |
|
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters. |
Here is an example of the data from a request to open the checkout page by using EPayWidget
:
EPayWidget.run( { project_id: 1234, payment_id: 'payment_47', customer_id: 'customer_123', customer_first_name: 'John', customer_last_name: 'Doe', customer_email: 'johndoe@example.com', identify_doc_number: '12345678901', identify_doc_type: 'CI', customer_account_number: '1234567890', account_type: 'SVGS', payment_currency: 'BOB', payment_amount: 10000, force_payment_method: 'bank-transfer-bolivia', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg==' } )
Callback
In the Bank transfers in Bolivia payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.
The following is an example of a callback body with information about a successfully completed purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 28, "type": "sale", "status": "success", "date": "2022-03-25T11:08:45+0000", "created_date": "2022-03-25T11:08:05+0000", "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839", "sum_initial": { "amount": 10000, "currency": "BOB" }, "sum_converted": { "amount": 10000, "currency": "BOB" }, "code": "0", "message": "Success", "provider": { "id": 12345, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is an example of a callback for a declined purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 31, "type": "sale", "status": "decline", "date": "2022-03-25T11:20:30+0000", "created_date": "2022-03-25T11:19:53+0000", "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb", "sum_initial": { "amount": 10000, "currency": "BOB" }, "sum_converted": { "amount": 10000, "currency": "BOB" }, "code": "20000", "message": "General decline", "provider": { "id": 15923, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
Purchase by using Gate
General information
To perform a purchase by using Gate with the Bank transfers in Bolivia payment method:
- Send the request with all the required parameters and signature to the Monetix URL.
- Redirect the customer to the provider service.
- Accept the callback with the purchase result from the payment platform.
The following figure provides the details of the purchase processing flow in the Bank transfers in Bolivia payment method.
- The customer initiates a purchase in your system.
- Your system sends the purchase request to Gate.
- The Monetix payment platform receives the request.
- The payment platform checks whether the request contains all the required parameters and correct signature.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the purchase request.
- The provider service sends the customer redirection data to the payment platform.
- The payment platform forwards the data to your system in the redirect_data object.
- Your system redirects the customer to the provider service.
- The customer completes the purchase.
- The provider service processes the purchase.
- The result is displayed to the customer.
- The customer is redirected to your system.
- The provider service informs the payment platform about the purchase result.
- The payment platform sends the callback with the payment result to your system.
- Your system sends the payment result to the customer.
Request
This section provides the instructions on how to build the request for purchase with the Bank transfers in Bolivia payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/bank-transfer/bolivia/sale |
Full API endpoint specification | /v2/payment/bank-transfer/{payment_method}/sale |
|
||||
---|---|---|---|---|
Object | Parameter | Description | ||
general |
project_id |
Project ID you obtained from Monetix when integrating. Example: |
||
payment_id |
Payment ID unique within your project. Example: |
|||
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | |||
customer |
id |
Unique ID of the customer within your project. Example: |
||
ip_address |
IP address of the customer's device. Example: |
|||
email |
Customer's email. Example: |
|||
first_name |
Customer's first name. Example: |
|||
last_name |
Customer's last name. Example: |
|||
identify |
doc_number |
Number of the document proving your customer's identity. Example: |
||
doc_type |
The type of the document proving your customer's identity. Possible values:
Example: |
|||
payment |
amount |
Purchase 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 |
||
currency |
Code of the purchase currency in the ISO-4217 alpha-3 format. Example: |
|||
account |
type |
Customer's account type. Possible values: CACC —for the current account, SVGS —for the savings account.Example: |
||
number |
Customer's account number. Example: |
|||
return_url |
return |
The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix. Example: |
||
success |
The URL to redirect the customer to after the payment is successfully completed. Example: |
|||
decline |
The URL to redirect the customer to after the payment is declined. Example: |
|||
You can also add any other optional parameters to the purchase 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 purchase with the Bank transfers in Bolivia payment method.
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA==" }, "customer": { "id": "customer_123", "ip_address": "198.51.100.47", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "identify": { "doc_type": "CI", "doc_number": "12345678901" } }, "account": { "type": "SVGS", "number": "1234567890" }, "payment": { "amount": 10000, "currency": "BOB" }, "return_url": { "success": "https://example.com/success/", "decline": "https://example.com/decline/", "return": "https://example.com/return/" } }
Customer redirection
After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider service.
To redirect the customer, use the values of the following parameters in the redirect_data object:
- url—the URL to redirect the customer to
- body—the data to send in the request body
- method—the HTTP method for retrieving the website page (for example, POST or GET)
- encrypted—this is the service parameter. Ignore it.
Here is an example of the callback snippet with the data to redirect the customer.
"redirect_data": { "method": "GET", "body": [], "encrypted": [], "url": "https://example.com/redirect" }
Callback
In the Bank transfers in Bolivia payment method, the payment platform returns the purchase 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 purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 28, "type": "sale", "status": "success", "date": "2022-03-25T11:08:45+0000", "created_date": "2022-03-25T11:08:05+0000", "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839", "sum_initial": { "amount": 10000, "currency": "BOB" }, "sum_converted": { "amount": 10000, "currency": "BOB" }, "code": "0", "message": "Success", "provider": { "id": 12345, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is an example of a callback for a declined purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 31, "type": "sale", "status": "decline", "date": "2022-03-25T11:20:30+0000", "created_date": "2022-03-25T11:19:53+0000", "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb", "sum_initial": { "amount": 10000, "currency": "BOB" }, "sum_converted": { "amount": 10000, "currency": "BOB" }, "code": "20000", "message": "General decline", "provider": { "id": 15923, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
Payout by using Gate
General information
To perform a payout by using Gate with the Bank transfers in Bolivia payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept a 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.
- The customer initiates a payout in your system.
- Your system sends the payout request to Gate.
- The Monetix payment platform receives the request.
- The payment platform checks whether the request contains all the required parameters and correct signature.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes this request.
- The provider service informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- Your system sends the payout result to the customer.
Request
This section provides the instructions on how to build the payout request through Gate by using 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 |
|
||||
---|---|---|---|---|
Object | Parameter | Description | ||
general |
project_id |
Project ID you obtained from Monetix when integrating. Example: |
||
payment_id |
Payment ID unique within your project. Example: |
|||
signature |
Signature created after you've specified all the request parameters. To learn about signature generation, see Signature generation and verification. | |||
customer |
id |
Unique ID of the customer within your project. Example: |
||
ip_address |
IP address of the customer's device. Example: |
|||
email |
Customer's email. Example: |
|||
first_name |
Customer's first name. Example: |
|||
last_name |
Customer's last name. Example: |
|||
identify |
doc_number |
Number of the document proving your customer's identity. Example: |
||
doc_type |
The type of the document proving your customer's identity. Possible values:
Example: |
|||
payment |
amount |
Payout 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 |
||
currency |
Code of the payout currency in the ISO-4217 alpha-3 format. Example: |
|||
account |
bank_id |
Customer's bank ID. For the information about the list of supported banks IDs, see Supported banks. Example: |
||
number |
Customer's account number. Example: |
|||
type |
Customer's account type. Possible values: CACC —for the current account, SVGS —for the savings account.Example: |
|||
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.
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA==" }, "customer": { "id": "customer_123", "ip_address": "198.51.100.47", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "identify": { "doc_type": "CI", "doc_number": "12345678901" } }, "account": { "number": "1234567890", "type": "SVGS", "bank_id": 75542 }, "payment": { "amount": 10000, "currency": "BOB" } }
Supported banks
In the Bank transfers in Bolivia payment method, payouts are performed through the banks the payment method supports. You are required to specify the ID of the customer's bank in the account.bank_id parameter of your payout request.
The table below lists the banks available for payout in the Bank transfers in Bolivia payment method.
Bank | ID |
---|---|
1 de Septiembre Ltda. | 78852 |
2 de Junio Abasto Ltda | 78702 |
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 BISA | 75626 |
Banco de Crédito de Bolivia | 75542 |
Banco de la Nacían Argentina | 75936 |
Banco do Brasil | 75616 |
Banco Ecofuturo | 75896 |
Banco Economico | 75646 |
Banco Fassil | 75886 |
Banco FIE | 75876 |
Banco Fortaleza | 75906 |
Banco Ganadero | 75666 |
BANCO MERCANTIL SANTA CRUZ S.A | 78682 |
BANCO MERCANTIL | 74552 |
Banco Nacional de Bolivia | 75606 |
Banco para el Fomento a Iniciativas Económicas S.A. | 78552 |
Banco Pyme de la Comunidad | 75866 |
BANCO PYME LOS ANDES PROCREDIT S.A. | 78532 |
Banco Solidario | 75656 |
Banco Union | 75636 |
Billetera Movil de Entel | 75956 |
Caceres Ltda | 78632 |
Cantera Ltda. | 78882 |
Compañia Interamericana de Servicios S.R.L. | 78642 |
Concordia Ltda | 78892 |
Cooperativa Catedral | 75846 |
Cooperativa Comarapa | 75806 |
Cooperativa Educadores Gran Chaco | 75836 |
Cooperativa El Chorolque | 75826 |
Cooperativa Fatima | 75726 |
Cooperativa Jesus Nazareno | 75706 |
Cooperativa La Merced | 75926 |
Cooperativa Loyola | 75746 |
Cooperativa PIO X | 75766 |
Cooperativa Quillacollo | 75776 |
Cooperativa San Antonio | 75756 |
Cooperativa San Jose de Punata | 75786 |
Cooperativa San Martin | 75716 |
Cooperativa San Mateo | 75816 |
Cooperativa San Pedro | 75736 |
Cooperativa Trinidad | 75796 |
Cooprole Ltda. | 78712 |
Credicoop Ltda | 78902 |
Crédito Abierta Jesús Nazareno Ltda | 79112 |
Credito con Educacion Rural Institucion Financiera de Desarrollo (CRECER IFD) | 78562 |
Cristo Rey Ltda. | 78722 |
Diaconia IFD | 78572 |
El Buen Samaritano Ltda. | 78732 |
El Churqui Ltda | 78742 |
El Cristo Ltda | 78912 |
EMPETROL Ltda | 78752 |
EUROENVIOS S.R.L | 78662 |
FONDECO IFD | 78582 |
FUBODE IFD | 78592 |
Gran Grigotá Ltda. | 78762 |
Hospicio Ltda. | 78922 |
Ibercoop Ltda | 78932 |
IDEPRO IFD | 78602 |
IMPRO IFD | 78612 |
Institución Financiera de Desarrollo CIDRE | 78542 |
Institucion Financiera de Desarrollo | 75916 |
Jerusalén Ltda. | 78942 |
La Primavera Ltda. | 78952 |
La Sagrada Familia Ltda. | 78772 |
Magisterio Rural de Chuquisaca Ltda. | 78782 |
Magisterio Rural | 75856 |
More Bolivia S.A | 78652 |
Multiactiva Santiago de Munaypata Ltda | 79102 |
Mutual el Progreso | 75696 |
Mutual la Primera | 75676 |
Mutual la Promotora | 75686 |
Nuestra Señora de Los Remedios Ltda. | 78792 |
Paulo VI Ltda. | 78962 |
Perú Services S.R.L | 78692 |
Piraí Ltda | 78972 |
Reyes Ltda. | 78982 |
Sacarosa Ltda. | 78802 |
San Bartolomé Ltda | 78992 |
San Francisco de Asís Ltda. | 79002 |
San Francisco Solano Ltda. | 78812 |
San Gabriel Ltda. | 79012 |
Sarco Ltda | 78822 |
Señor de Burgos Ltda. | 79022 |
Solucredit San Silvestre | 79032 |
Terracoop Ltda. | 79042 |
Tigo Money | 75946 |
Tukuypaj Ltda. | 78832 |
Varsa Ltda. | 79052 |
Vía y Obras Ltda. | 79062 |
Vinto Ltda. | 79072 |
Virgen de los Remedios Ltda | 79082 |
Virgen de Urkupiña Ltda. | 79092 |
YAPE | 79122 |
Note that the list of banks in the table is provided for informational purposes only. It may change without notice. To get the current list of banks, send a request to the payment platform, as follows:
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 |
Object | Parameter | Description |
---|---|---|
general |
project_id |
Project ID you obtained when integrating with Monetix. |
payment_id |
Payment ID unique within the project. If the payment is not yet created, set this parameter to a unique value. |
|
signature |
Signature created after you specify all the required parameters. For more information about, signature generation, see Signature generation and verification. | |
payment |
amount |
Payout 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. |
currency |
Code of the payout currency in the ISO-4217 alpha-3 format. |
Here is an example of the data from the request for the list of banks available in the Bank transfers in Bolivia payment method:
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jllym+PtObocZtr345st...==" }, "payment": { "amount": 10000, "currency": "BOB" } }
[ { "id": 75606, // Bank ID "abbr": "BANADEBOL", // Bank shortcut name (for internal use) "name": "Banco Nacional de Bolivia", // General bank name "nativeName": "Banco Nacional de Bolivia", // Native bank name "currencies": [ // Array with currencies supported by the bank { "id": 1130, // 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": "068", // Numeric code of the payment currency in the ISO-4217 alpha-3 format "alias": "BOB", // Alphabetic code of the payment currency "exponent": 2 // Number of decimal places after decimal point } ] }, { "id": 75626, "abbr": "BANCOBISA", "name": "Banco BISA", "nativeName": "Banco BISA", "currencies": [ { "id": 1130, "alpha_3_4217": "BOB", "number_3_4217": "068", "alias": "BOB", "exponent": 2 } ] } ]
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.
{ "project_id": 1234, "payment": { "id": "payment_48", "type": "payout", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "account": { "number": "1234567890" }, "customer": { "id": "customer_123" }, "operation": { "id": 29, "type": "payout", "status": "success", "date": "2022-03-25T11:08:45+0000", "created_date": "2022-03-25T11:08:05+0000", "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839", "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": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is an example of a callback for a declined payout.
{ "project_id": 1234, "payment": { "id": "payment_48", "type": "payout", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Bank transfer Bolivia", "sum": { "amount": 10000, "currency": "BOB" }, "description": "" }, "account": { "number": "1234567890" }, "customer": { "id": "customer_123" }, "operation": { "id": 29, "type": "payout", "status": "decline", "date": "2022-03-25T11:20:30+0000", "created_date": "2022-03-25T11:19:53+0000", "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb", "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": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
Payout by using 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.
Analysis of payments results
As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.
You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com
), for instance you can use the analytic panels in the Analytics section for this purpose.
Also, you can export the information for further analysis by using third party analytical tools. The following options are available:
- Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
- Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.
If you have any further questions regarding payment data analysis, contact Monetix technical support.