Bank transfers IBAN in Ukraine

Operations support

	Interfaces		Payment amount, UAH		Payment processing time
	Gate	Dashboard	minimum	maximum	basic	threshold
Payout			500.00	50,000.00	10 minutes	24 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.

General information

To perform a payout by using Gate with the Bank transfers IBAN in Ukraine 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 IBAN in Ukraine payment method.

Request

This section provides the instructions on how to build the payout request through Gate by using the Bank transfers IBAN in Ukraine payment method.

Here is an example of the data from a request to initiate a payout with the Bank transfers IBAN in Ukraine 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_number": "3429507454"
    }
    },
    "account": {
        "number": "UA123456789012345678901234567",
        "bank_id": 76736
    },
    "payment": {
        "amount": 50000,
        "currency": "UAH"
    }
}

Supported banks

In the Bank transfers IBAN in Ukraine 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 IBAN in Ukraine payment method.

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:

Here is an example of the data from the request for the list of banks available in the Bank transfers IBAN in Ukraine payment method:

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jllym+PtObocZtr345st...=="
    },
    "payment": {
        "amount": 50000,
        "currency": "UAH"
    }
}

[
  {
    "id": 76736, // Bank ID
    "abbr": "MB", // Bank shortcut name (for internal use)
    "name": "monobank", // General bank name
    "nativeName": "monobank", // Native bank name
    "currencies": [ // Array with currencies supported by the bank
      {
        "id": 980, // Currency ID in the payment platform
        "alpha_3_4217": "UAH", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
        "number_3_4217": "980", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
        "exponent": 2 // Number of decimal places after decimal point
      }
    ]
  },
  {
    "id": 77206,
    "abbr": "Приват Банк",
    "name": "Приват Банк",
    "nativeName": "Приват Банк",
    "currencies": [
      {
        "id": 980,
        "alpha_3_4217": "UAH",
        "number_3_4217": "980",
        "exponent": 2
      }
    ]
  }
]

Callback

In the Bank transfers IBAN in Ukraine 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 Ukraine",
        "sum": {
            "amount": 50000,
            "currency": "UAH"
        },
        "description": ""
    },
    "account": {
        "number": "UA123456789012345678901234567"
    },
    "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": 50000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "UAH"
        },
        "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 Ukraine",
        "sum": {
            "amount": 50000,
            "currency": "UAH"
        },
        "description": ""
    },
    "account": {
        "number": "UA123456789012345678901234567"
    },
    "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": 50000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "UAH"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

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.

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.