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 Japan
Payment currencies JPY
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.
Special considerations
  • The amounts for the JPY 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 1000 JPY purchase in your system, you are required to submit the 1000 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.

  • Object account contains recipient's bank account information. Specialized registers can be used to find and verify information about banks. For more information, see Banks available for payout.
Note: Ask your key account manager at Monetix whether the following payment processing considerations are relevant to you.
  • In some cases, during weekends and non-working hours, payments are not processed, callbacks are not sent, and requests for payouts are delayed until business hours. For more information, contact your Monetix key account manager.
  • In some cases after sending the request with correct data the basic time of payout processing is one business day according to the provider's schedule, the threshold time is two business days according to the schedule.

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 Banks of Japan 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 Japan 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 bank service.
  5. The bank 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 Banks of Japan payment method.

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

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

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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

number
string
strictly required

Recipient's bank account number (the value must be no more than seven digits and must not contain any other characters). Title for displaying on the user interface—銀行口座番号.

Example: 4000002

bank_name
string
strictly required

Recipient's bank name. Title for displaying on the user interface—受取銀行名.

Example: 三菱ＵＦＪ銀行

branch
string
strictly required

Recipient's bank branch name. Title for displaying on the user interface—受取銀行支店名.

Example: 千葉支店

customer_name
string
strictly required

Recipient's bank account owner's name (in Katakana). Title for displaying on the user interface—口座名義(カタカナ).

Example: マツダヒロヒト

bank_code
string
strictly required

Recipient's bank code (the value must be no more than four digits and must not contain any other characters). Title for displaying on the user interface—受取銀行コード.

Example: 0005

branch_code
string
strictly required

Recipient's bank branch code (the value must be no more than three digits and must not contain any other characters. Title for displaying on the user interface—受取銀行支店コード.

Example: 123

native_customer_name
string
strictly required

Recipient's bank account owner's name (in Kanji). Title for displaying on the user interface—口座名義(漢字).

Example: 松田 博仁

payment
object
strictly required

currency
string
strictly required

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

Example: JPY

amount
integer
strictly required

Payment 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: 100,000 JPY must be sent as 100000

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 Banks of Japan 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",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "4000002",
        "bank_name": "三菱ＵＦＪ銀行",
        "branch": "千葉支店",
        "customer_name": "マツダヒロヒト",
        "bank_code": "0005",
        "branch_code": "123",
        "native_customer_name": "松田 博仁"
    },
    "payment": {
        "currency": "JPY",
        "amount": 100000
    }
}

Callback

In the Banks of Japan 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": "japan",
        "sum": {
            "amount": 100000,
            "currency": "JPY"
        },
        "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": 100000,
            "currency": "JPY"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "JPY"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "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": "japan",
        "sum": {
            "amount": 100000,
            "currency": "JPY"
        },
        "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": 100000,
            "currency": "JPY"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "JPY"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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.

Banks available for payout

Banks available for payout

In the Banks of Japan payment method, payments are performed through the banks the payment method supports. For the payout to be performed, your request must contain recipient's bank account information in the account parameter.

Specialized registers can be used to find and verify information about banks: List of banks with names and codes of recipients' banks and List of bank branches with names and codes of branches of those banks.

As required by the provider, the user interface must use the strictly defined parameter titles in Japanese.