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 Taiwan, Province of China
Payment currencies TWD
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.

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 Taiwan 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 Taiwan 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 provider service.
  5. The provider 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 Taiwan payment method.

HTTP request method POST
Request body format JSON
API endpointv2/payment/banks/taiwan/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

Customer's account number.

Example: 12345678901234

bank_id
integer
strictly required

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

Example: 88202

customer_name
string
strictly required

Customer's full name.

Example: 张三

branch_name
string
strictly required

Name of the recipient's bank branch.

Example: 南投三和郵局

payment
object
strictly required

currency
string
strictly required

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

Example: TWD

amount
integer
strictly required

Payment 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 units and Currency codes.

Example: 100.00 TWD must be sent as 10000

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 Taiwan 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": "12345678901234",
        "bank_id": 88202,
        "customer_name": "张三",
        "branch_name": "南投三和郵局"
    },
    "payment": {
        "currency": "TWD",
        "amount": 10000
    }
}

Callback

In the Banks of Taiwan 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": "Taiwan banks",
        "sum": {
            "amount": 10000,
            "currency": "TWD"
        },
        "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": "TWD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "TWD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "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": "Taiwan banks",
        "sum": {
            "amount": 10000,
            "currency": "TWD"
        },
        "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": "TWD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "TWD"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Payout by using Dashboard

To make a payout through Dashboard, your system 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

Supported banks

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

Table 2. Banks available for payout
BankID
Bank of Kaohsiung3131
Bank of Panhsin3301
Bank of Taiwan3031
Bank SinoPac3361
Cathay United Bank3121
Chang Hwa Bank3081
Citibank3161
COTA Commercial Bank Co.,Ltd.3311
CTBC Bank3441
DBS Bank (Taiwan) , Ltd.4131
E.SUN Commercial Bank3371
Entie Commercial Bank3431
Far Eastern Int`l Bank3341
First Commercial Bank3061
HSBC Bank3261
Hua Nan Bank3071
Hwatai Bank3281
KGI Bank3381
King's Town Bank4101
Land Bank of Taiwan3041
Mega International Commercial Bank3141
NEXT Commercial Bank Co., Ltd.88202
O-Bank Co., Ltd.4081
Shin Kong Commercial Bank4121
Standard Chartered Bank3271
Sunny Bank Ltd.3291
Taichung Commercial Bank3231
Taipei Star Bank4111
Taishin International Bank3401
Taiwan Business Bank3211
Taiwan Cooperative Bank3051
The Export-Import Bank of the Republic of China4071
The Shanghai Commercial and Savings Bank3101
Union Bank of Taiwan3321
Yuanta Commercial Bank Co., Ltd.3351

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 Taiwan payment method supports, reach out to the Monetix support team (support@monetix.pro).