Bank Account Information

>>>

POST /api/v1/bank_account_information
Create Bank Account Information

Creates a new bank account information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X POST https://komoju.com/api/v1/live_application/bank_account_information \
  -u sk_123456: \
  -d "zengin_bank_name=ALKEN%20ASSET%20MANAGEMENT" \
  -d "zengin_bank_code=0005" \
  -d "zengin_branch_name=Donaldfurt" \
  -d "zengin_branch_code=220" \
  -d "zengin_account_type=ordinary" \
  -d "zengin_account_number=3446092" \
  -d "zengin_account_holder=Lockman%20Inc" \
  -d "zengin_account_holder_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "transfer_type=domestic" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var post_data = querystring.stringify({
  'zengin_bank_name': 'ALKEN ASSET MANAGEMENT',
  'zengin_bank_code': '0005',
  'zengin_branch_name': 'Donaldfurt',
  'zengin_branch_code': '220',
  'zengin_account_type': 'ordinary',
  'zengin_account_number': '3446092',
  'zengin_account_holder': 'Lockman Inc',
  'zengin_account_holder_kana': 'ｶﾀｶﾅ',
  'transfer_type': 'domestic'
});

var post_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/bank_account_information',
  method: 'POST',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(post_data)
  }
};

var post_req = https.request(post_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

post_req.write(post_data);
post_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/bank_account_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  zengin_bank_name: "ALKEN ASSET MANAGEMENT",
  zengin_bank_code: "0005",
  zengin_branch_name: "Donaldfurt",
  zengin_branch_code: "220",
  zengin_account_type: "ordinary",
  zengin_account_number: "3446092",
  zengin_account_holder: "Lockman Inc",
  zengin_account_holder_kana: "ｶﾀｶﾅ",
  transfer_type: "domestic"
}

res = https.post(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "resource": "bank_account_information",
  "status": "pending",
  "created_at": "2021-03-05T13:52:24.000+09:00",
  "updated_at": "2021-03-05T13:52:24.000+09:00",
  "swift_bank_name": "",
  "swift_branch_name": "",
  "swift_branch_address": "",
  "swift_account_number": "",
  "swift_account_holder": "",
  "swift_account_address": "",
  "swift_bic_code": "",
  "zengin_bank_name": "みずほ銀行",
  "zengin_bank_code": "0001",
  "zengin_branch_name": "水戸支店",
  "zengin_branch_code": "316",
  "zengin_account_type": "ordinary",
  "zengin_account_number": "1234567",
  "zengin_account_holder": "古茂樹 太郎",
  "zengin_account_holder_kana": "ｺﾓｼﾞｭ ﾀﾛｳ",
  "sepa_iban": "",
  "sepa_swift_bic_code": "",
  "sepa_account_holder": "",
  "transfer_type": "domestic"
}

Params

Param name Description
transfer_type
optional

The type of the bank account.

It must be one of the following values
  • domestic
  • swift
  • sepa
swift_bank_name
optional

SWIFT Bank Name, e.g. AMRO BANK.
swift_branch_name
optional

SWIFT Branch Name, e.g. AMSTERDAM.
swift_branch_address
optional

SWIFT Branch Address, e.g. GUSTAV 10
swift_account_number
optional

SWIFT Account Number, e.g. 1234
swift_account_holder
optional

SWIFT Account Holder, e.g. Adam Smith
swift_account_address
optional

SWIFT Account Holder Address, e.g. MAHLERLAAN 10
swift_bic_code
optional

SWIFT / ABA Code, e.g. ABNANL2A
zengin_bank_name
optional

Zengin Bank Name, e.g. みずほ銀行
zengin_bank_code
optional

Zengin Branch Code, e.g. 0001
zengin_branch_name
optional

Zengin Branch Name, e.g. 水戸支店
zengin_branch_code
optional

Zengin Branch Code, e.g. 316
zengin_account_type
optional

Zengin Account Type, it can be either ordinary or checking. E.g. ordinary
zengin_account_number
optional

Zengin Account Number, e.g. 1234567
zengin_account_holder
optional

Zengin Account Holder, e.g. 古茂樹 太郎
zengin_account_holder_kana
optional

Zengin Account Holder (Kana), e.g. ｺﾓｼﾞｭ ﾀﾛｳ
sepa_iban
optional

SEPA (Single Euro Payments Area) IBAN (International Bank Account Number)
sepa_swift_bic_code
optional

SEPA BIC (Business Identifier Codes) / SWIFT
sepa_account_holder
optional

SEPA Account Holder
>>>

GET /api/v1/bank_account_information
Show Bank Account Information

Show the fields of an existing bank account information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X GET https://komoju.com/api/v1/live_application/bank_account_information \
  -u sk_123456:
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var get_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/bank_account_information',
  method: 'GET',
  headers: {
    'Authorization': auth
  }
};

var get_req = https.request(get_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

get_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/bank_account_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

res = https.get(uri.path, headers)
puts res.body
{
  "resource": "bank_account_information",
  "status": "pending",
  "created_at": "2021-03-05T13:52:24.000+09:00",
  "updated_at": "2021-03-05T13:52:24.000+09:00",
  "swift_bank_name": "",
  "swift_branch_name": "",
  "swift_branch_address": "",
  "swift_account_number": "",
  "swift_account_holder": "",
  "swift_account_address": "",
  "swift_bic_code": "",
  "zengin_bank_name": "みずほ銀行",
  "zengin_bank_code": "0001",
  "zengin_branch_name": "水戸支店",
  "zengin_branch_code": "316",
  "zengin_account_type": "ordinary",
  "zengin_account_number": "1234567",
  "zengin_account_holder": "古茂樹 太郎",
  "zengin_account_holder_kana": "ｺﾓｼﾞｭ ﾀﾛｳ",
  "sepa_iban": "",
  "sepa_swift_bic_code": "",
  "sepa_account_holder": "",
  "transfer_type": "domestic"
}
>>>

PATCH /api/v1/bank_account_information
Update Bank Account Information

Update the fields of an existing bank account information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X PATCH https://komoju.com/api/v1/live_application/bank_account_information \
  -u sk_123456: \
  -d "zengin_bank_name=I%20am%20changing%20this%20in%20this%20request" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var patch_data = querystring.stringify({
  'zengin_bank_name': 'I am changing this in this request'
});

var patch_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/bank_account_information',
  method: 'PATCH',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(patch_data)
  }
};

var patch_req = https.request(patch_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

patch_req.write(patch_data);
patch_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/bank_account_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  zengin_bank_name: "I am changing this in this request"
}

res = https.patch(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "resource": "bank_account_information",
  "status": "pending",
  "created_at": "2021-03-05T13:52:24.000+09:00",
  "updated_at": "2021-03-05T13:52:24.000+09:00",
  "swift_bank_name": "",
  "swift_branch_name": "",
  "swift_branch_address": "",
  "swift_account_number": "",
  "swift_account_holder": "",
  "swift_account_address": "",
  "swift_bic_code": "",
  "zengin_bank_name": "I am changing this in this request",
  "zengin_bank_code": "0001",
  "zengin_branch_name": "水戸支店",
  "zengin_branch_code": "316",
  "zengin_account_type": "ordinary",
  "zengin_account_number": "1234567",
  "zengin_account_holder": "古茂樹 太郎",
  "zengin_account_holder_kana": "ｺﾓｼﾞｭ ﾀﾛｳ",
  "sepa_iban": "",
  "sepa_swift_bic_code": "",
  "sepa_account_holder": "",
  "transfer_type": "domestic"
}

Params

Param name Description
transfer_type
optional

The type of the bank account.

It must be one of the following values
  • domestic
  • swift
  • sepa
swift_bank_name
optional

SWIFT Bank Name, e.g. AMRO BANK.
swift_branch_name
optional

SWIFT Branch Name, e.g. AMSTERDAM.
swift_branch_address
optional

SWIFT Branch Address, e.g. GUSTAV 10
swift_account_number
optional

SWIFT Account Number, e.g. 1234
swift_account_holder
optional

SWIFT Account Holder, e.g. Adam Smith
swift_account_address
optional

SWIFT Account Holder Address, e.g. MAHLERLAAN 10
swift_bic_code
optional

SWIFT / ABA Code, e.g. ABNANL2A
zengin_bank_name
optional

Zengin Bank Name, e.g. みずほ銀行
zengin_bank_code
optional

Zengin Branch Code, e.g. 0001
zengin_branch_name
optional

Zengin Branch Name, e.g. 水戸支店
zengin_branch_code
optional

Zengin Branch Code, e.g. 316
zengin_account_type
optional

Zengin Account Type, it can be either ordinary or checking. E.g. ordinary
zengin_account_number
optional

Zengin Account Number, e.g. 1234567
zengin_account_holder
optional

Zengin Account Holder, e.g. 古茂樹 太郎
zengin_account_holder_kana
optional

Zengin Account Holder (Kana), e.g. ｺﾓｼﾞｭ ﾀﾛｳ
sepa_iban
optional

SEPA (Single Euro Payments Area) IBAN (International Bank Account Number)
sepa_swift_bic_code
optional

SEPA BIC (Business Identifier Codes) / SWIFT
sepa_account_holder
optional

SEPA Account Holder