Skip to content

BankPay

This alternative payment method supports the following operations:

Payment

Request

Send a payment request with the following additional data:

Parameter Type Description
method object A section of the payment method information.
type * required
 string bank_pay
channel string The merchant name displayed to the customer where the customer's funds will be credited to. If empty or not provided, then the name presented is the name configured by us on the settlement account. Use this if you are processing for multiple brands under a single settlement account.
customer object A section of the customer details.
first_name string The customer's first name. Length: up to 30 symbols.
last_name string The customer's last name. Length: up to 30 symbols.
middle_name string The customer's middle name. Length: up to 30 symbols.
email string An email of the customer making a purchase at your shop.
country * required
 string The customer's billing country in the ISO 3166-1 Alpha-2 format.
city string The customer's billing city. Max length: 60 chars.
zip string The customer's billing ZIP or postal code. If country=US, zip format must be NNNNN or NNNNN-NNNN.
address string The customer's billing address. Max length: 255 chars.
phone string The customer's phone number. Max length: 100 chars.
additional_data object A section of additional data.
customer object A section of additional data about the customer.
id * required
 string A unique ID of the customer in your system.
Response

The bank_pay response section will have the parameters copied from the request.

Payout

Request

Send a payout request with the following additional data:

Parameter Type Description
method object A section of the payment method information.
type * required
 string bank_pay
account * conditionally required
 string A number of the bank account being transferred to.
region_account * required
 string The Regional Bank Account Number. The Regional Bank Account number can be used in place of a detailed bank account number in some countries. e.g, IBAN in Europe, BSB in Australia, etc.
bank_name * conditionally required
 string The name of the bank that holds the bank account that the funds are transferred to.
bank_bic_number * conditionally required
 string The BIC/SWIFT number of the bank account that the funds are transferred to.
bank_code * conditionally required
 string The bank code of the bank where the funds are transferred to.
bank_branch_code * conditionally required
 string The branch Code of the bank where that the funds are transferred to.
check_digit * conditionally required
 string The trailing check digits used within the bank account that the funds are transferred to.
customer object A section of the customer details.
first_name * required
 string The customer's first name. Length: up to 30 symbols.
last_name * required
 string The customer's last name. Length: up to 30 symbols.
middle_name * required
 string The customer's middle name. Length: up to 30 symbols.
email * required
 string An email of the customer making a purchase at your shop.
country * required
 string The customer's billing country in the ISO 3166-1 Alpha-2 format.
city * required
 string The customer's billing city. Max length: 60 chars.
zip * required
 string The customer's billing ZIP or postal code. If country=US, zip format must be NNNNN or NNNNN-NNNN.
address * required
 string The customer's billing address. Max length: 255 chars.
phone * required
 string The customer's phone number. Max length: 100 chars.
id_number * required
 string The customer's identification document number.
additional_data object A section of additional data.
customer object A section of additional data about the customer.
id * conditionally required
 string A unique ID of the customer in your system.

Info

Refer to Country specific fields section to know what fields are required in your case.

Country specific fields

This section lists what 'conditional' fields of the payout request must be provided based on the country the payout is being issued within.

Field Name China Japan Turkey
bank_bic_number optional optional optional
region_account required (full account number) optional required (IBAN)
bank_code optional optional optional
bank_branch_code optional required (3-digit code) optional
account optional required (full account number) optional
check_digit optional optional optional
Response

The bank_pay response section will have the parameters copied from the request.