Bank transfers in Paraguay

Overview

Bank transfers in Paraguay, a popular payment method in Paraguay, offers your customers a convenient way of paying for your services and receiving payouts. In the Bank transfers in Paraguay payment method, customers make purchases by using bank transfers.

With Bank transfers in Paraguay, 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 Paraguay
Payment currencies PYG
Currency conversion On the Monetix side
Purchases
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations
  • If the customer transfers an amount which is different from the amount specified in the purchase request, the payment processing will proceed as described in Handling payments with amount changed by customer.
  • The amounts for the PYG currency must be specified in major currency units (without any fractional part) according to the ISO-4217 alpha-3 standard.

    For example, if the customer initiates a 10 000 PYG purchase in your system, you are required to submit the 10000 as the payment amount in your purchase request.

    You can check the number of digits for minor currency units for any currency in Currency codes.

  • If the customer fails to complete the payment within 3 hours, the payment will be declined.
  • In some cases, the payouts can be credited to the customer at the particular time.

    During business hours: payouts requested before 5:00 p.m. (Paraguay time) will be credited at 5:00 p.m., and a payout confirmation will be sent to your system at 11:59 p.m.

    Outside of business hours and during weekends: payouts requested after 5:00 p.m. (Paraguay time) on a business day or during weekends and holidays will be credited at 5:00 p.m. on the following business day. A payout confirmation will be sent to your system at 11:59 p.m. on the following business day.

    Please check with your Monetix key account manager if this feature is relevant to you.

  • The payment details shown in the payment instructions can be used for purchase only once. The customer must initiate a new purchase in your system to make another payment.
Onboarding and access fee Contact your key account manager at Monetix for details.

Operations support

Interfaces Payment amount, PYG Payment processing time
Payment Page Gate Dashboard minimum maximum basic threshold
Purchase 10 000 70 000 000 10 minutes 3 hours
Payout 10 000 70 000 000 10 minutes 48 hours

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 Paraguay payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. 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 Paraguay payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The Monetix payment platform receives the request.
  4. The payment platform processes the request and checks whether it contains all the required parameters and the signature is correct.
  5. The payment platform creates the checkout page based on the project settings and request parameters.
  6. The checkout page is displayed to the customer.
  7. The customer chooses to make a purchase with the Bank transfers in Paraguay payment method.
  8. Payment Page forwards the purchase request to the payment platform.
  9. The payment platform processes the request and forwards it to the provider service.
  10. The provider service processes the purchase request.
  11. The provider service sends the customer redirection data to the payment platform.
  12. The payment platform forwards the data to Payment Page.
  13. Payment Page redirects the customer to the provider service.
  14. The customer completes the purchase.
  15. The provider service processes the purchase.
  16. The payment result is displayed to the customer in the provider service.
  17. The customer is redirected back to the checkout page.
  18. The provider service sends the purchase result information to the payment platform.
  19. The payment platform sends a callback with the payment result to your system.
  20. The payment platform sends the payment result to Payment Page.
  21. 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 Paraguay payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment_currency
string
strictly required

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

Example: PYG

payment_amount
integer
strictly required

Purchase amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 10 000 PYG must be sent as 10000

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.

force_payment_method
string
optional

Parameter that allows you to enforce the Bank transfers in Paraguay payment method for your customer and skip the page with payment method selections.

To enforce the Bank transfers in Paraguay payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to bank-transfer-paraguay. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'bank-transfer-paraguay'

identify_doc_number
string
optional

The number of the customer's CI (Cédula de identidad) document. Consists of 6-8 digits.

Example: 12345678

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',
        payment_currency: 'PYG',
        payment_amount: 10000,
        force_payment_method: 'bank-transfer-paraguay',    
        identify_doc_number: '12345678',   
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback

In the Bank transfers in Paraguay 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.

Figure 2. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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.

Figure 3. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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 Paraguay payment method:

  1. Send the request with all the required parameters and signature to the Monetix URL.
  2. Redirect the customer to the provider service.
  3. 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 Paraguay payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to Gate.
  3. The Monetix payment platform receives the request.
  4. The payment platform checks whether the request contains all the required parameters and correct signature.
  5. 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.)
  6. The payment platform processes the request and forwards it to the provider service.
  7. The provider service processes the purchase request.
  8. The provider service sends the customer redirection data to the payment platform.
  9. The payment platform forwards the data to your system in the redirect_data object.
  10. Your system redirects the customer to the provider service.
  11. The customer completes the purchase.
  12. The provider service processes the purchase.
  13. The result is displayed to the customer.
  14. The customer is redirected to your system.
  15. The provider service informs the payment platform about the purchase result.
  16. The payment platform sends the callback with the payment result to your system.
  17. 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 Paraguay payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/bank-transfer/paraguay/sale
Full API endpoint specification /v2/payment/bank-transfer/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

identify
object
optional

doc_number
string
optional

The number of the customer's CI (Cédula de identidad) document. Consists of 6-8 digits.

Example: 12345678

payment
object
strictly required

amount
integer
strictly required

Purchase amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 10 000 PYG must be sent as 10000

currency
string
strictly required

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

Example: PYG

return_url
object
optional

return
string
optional

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: https://example.com/return/

success
string
optional

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

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 Paraguay payment method.

Figure 5. Example of the data from a purchase request
{
    "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_number": "12345678"
        }
    },
    "payment": {
        "amount": 10000,
        "currency": "PYG"
    },
    "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 Paraguay 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.

Figure 6. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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.

Figure 7. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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 Paraguay payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. 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 Paraguay payment method.

Figure 8. 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 Gate.
  3. The Monetix payment platform receives the request.
  4. The payment platform checks whether the request contains all the required parameters and correct signature.
  5. 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.)
  6. The payment platform processes the request and forwards it to the provider service.
  7. The provider service processes this request.
  8. The provider service informs the payment platform about the payout result.
  9. The payment platform sends a callback with the payout result to your system.
  10. 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 Paraguay payment method.

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

strictly required—the parameter must be in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

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. To learn 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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

identify
object
strictly required

doc_number
string
strictly required

The number of the customer's CI (Cédula de identidad) document. Consists of 6-8 digits.

Example: 12345678

doc_type
string
strictly required

The type of the document proving your customer's identity. Possible value — CI for the customer ID (Cédula de Identidad).

Example: CI

payment
object
strictly required

amount
integer
strictly required

Payout amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 10 000 PYG must be sent as 10000

currency
string
strictly required

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

Example: PYG

account
object
strictly required

bank_id
integer
strictly required

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

Example: 76516

number
string
strictly required

Customer's account number.

Example: 1234567890

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 Paraguay payment method.

Figure 9. Example of payout request body
{
    "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": "9268839"
        }
    },
    "account": {
        "number": "6191707612",
        "bank_id": 76346
    },
    "payment": {
        "amount": 10000,
        "currency": "PYG"
    }
}

Supported banks

In the Bank transfers in Paraguay 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 payout request in the account.bank_id parameter.

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

Table 4. Banks available for payout
Bank ID
BANCO ATLAS 76516
BANCO BASA 76476
BANCO CONTINENTAL S.A. 76466
BANCO DO BRASIL S.A. 76436
BANCO FAMILIAR S.A.E.C.A. 76506
BANCO GNB PARAGUAY S.A. 76426
BANCO ITAU PARAGUAY S.A 76456
BANCO RIO S.A.E.C.A. 76496
BANCOP S.A. 76526
CITIBANK N.A. 76446
CRISOL Y ENCARNACION FINANCIERA S.A. 76636
FIC S.A. DE FINANZAS 76626
FINANCIERA EXPORTADORA PARAGUAYA S.A. 76596
FINLATINA S.A. DE FINANZAS 76566
INTERFISA BANCO 76536
PARAGUAYO-JAPONESA S.A.E.C.A 76586
SOLAR S.A. DE AHORRO Y PRESTAMO PARA LA VIVIENDA 76606
SUDAMERIS BANK S.A.E.C.A 76556
TU FINANCIERA S.A. 76616
VISION BANCO S.A.E.C.A. 76486

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/paraguay/payout/list
Full API endpoint specification /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list
Table 5. Parameters required in the request for the list of banks available for payout in this payment method
Object Parameter Description
general

project_id
integer
strictly required

Project ID you obtained when integrating with Monetix.

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.

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

amount
integer
strictly required

Payout amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

currency
string
strictly required

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 Paraguay payment method:

Figure 10. Example of the data from the request for the list of available banks
{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jllym+PtObocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "PYG"
    }
}
Figure 11. 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": "PYG", // 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": "PYG", // 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": 0 // Number of decimal places after decimal point
            }
        ]
    }
]

Callback

In the Bank transfers in Paraguay 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 12. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "description": ""
    },
    "account": {
        "number": "6191707612"
    },
    "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "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.

Figure 13. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Bank transfers in Paraguay",
        "sum": {
            "amount": 10000,
            "currency": "PYG"
        },
        "description": ""
    },
    "account": {
        "number": "6191707612"
    },
    "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": "PYG"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "PYG"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

Payout by using Dashboard

To make a payout through Dashboard, the merchant 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.

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.