Banks of Vietnam - Payout

General information

To perform a payout by using Gate with the Banks of Vietnam 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 Banks of Vietnam payment method.

Request

This section provides the instructions on how to build the request for payout with the Banks of Vietnam payment method.

Here is an example of the data from a request to initiate a payout with the Banks of Vietnam payment method:

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "1234567890",
        "bank_id": 61021,
        "customer_name": "Doe John"
    },
    "payment": {
        "currency": "VND",
        "amount": 10000
    }
}

Callback

In the Banks of Vietnam 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_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Vietnam banks",
        "sum": {
            "amount": 10000,
            "currency": "VND"
        },
        "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": "VND"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "VND"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456",
        "bank_id": "155"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Vietnam banks",
        "sum": {
            "amount": 10000,
            "currency": "VND"
        },
        "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": "VND"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "VND"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456",
        "bank_id": "155"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payouts with the Banks of Vietnam payment method by using Gate.

To start performing test payouts, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and then contact your key account manager at Monetix to set up the test environment for the payouts to be performed with the Banks of Vietnam payment method.

When performing test payouts, keep in mind that:

• for the project ID you have to submit the ID of the test project
• for the payment ID and customer's data you can submit any random values

Statuses of test payouts

To receive a certain final status when performing test payouts with the Banks of Vietnam payment method, your request has to contain a respective payment amount in it. The table below lists the payout amounts you can send in requests in order to get a certain status of a test payout.

Testing payout by using Gate

To perform a test payout by using Gate:

1. Send a correct test request for payout to the payment platform.
2. Accept a callback containing the data about the result of performing a test payout.

To learn more about performing payouts with the Banks of Vietnam payment method by using Gate, see the Payout by using Gate section.

Related topics

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

• 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.

Supported banks

In the Banks of Vietnam 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 Banks of Vietnam payment method.

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 Banks of Vietnam 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 Banks of Vietnam payment method. The request format and structure should be the following:

Here is an example of the data from the request for the list of banks available in the Banks of Vietnam payment method.

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "VND"
    }
}

[
    {
        "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": "VND", // 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": "VND", // 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
            }
        ]
    }
]