Recipientの作成

POSThttps://api.omise.co/recipients

Omise残高からのtransferを受け取るための銀行口座の詳細を含む新しいrecipientを作成します。Recipientは個人または法人が可能です。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 5 fieldsRequired Parameters

▼

`name`STRING(required)

Recipient名（個人名または会社名、銀行口座と一致する必要があります）。

Example:"John Doe"

`type`STRING(required)

Recipientのタイプ。

Example:"individual"

Values:individual, corporation

`bank_account.brand`STRING(required)

銀行コード（bbl、kbank、scb、ktb、bay、tmbなど）。

Example:"bbl"

`bank_account.number`STRING(required)

銀行口座番号（スペースやダッシュなし）。

Example:"1234567890"

`bank_account.name`STRING(required)

銀行に登録されている口座名義人の名前（大文字推奨）。

Example:"JOHN DOE"

Recommended - 2 fieldsRecommended Parameters

▼

Additional - 2 fieldsAdditional Parameters

▼

---

レスポンス

200

成功したトランザクション

Recipientが正常に作成されました。検証が完了するまでデフォルトでverified: falseとなります。

検証ステータス:

• verified: false - 検証保留中（新規作成）
• verified: true - アカウントが検証され、transferの準備ができています
• failure_code != null - 検証に失敗しました（failure_codeを確認してください）
• 完全な口座番号は返されません - セキュリティのため下4桁のみ

400

不正なリクエスト

リクエストの検証に失敗しました。詳細についてはエラーメッセージを確認してください。

一般的な原因:

• 必須フィールドの欠落（name、type、bank_accountフィールド）
• 無効な銀行口座形式
• 無効なrecipientタイプ
• 不正な形式のmetadata

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なsecret key
• Secret keyの代わりにpublic keyを使用
• HTTP Basic Auth形式が不正

422

処理できないエンティティ

銀行口座の検証に失敗しました。

一般的な原因:

• 無効な銀行口座番号
• 口座名義が銀行記録と一致しません
• サポートされていない銀行
• 銀行口座を検証できません

---

Code samples

cURL

curl https://api.omise.co/recipients \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Doe" \
  -d "type=individual" \
  -d "email=john@example.com" \
  -d "bank_account[brand]=bbl" \
  -d "bank_account[number]=1234567890" \
  -d "bank_account[name]=JOHN DOE"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.create(
    name='John Doe',
    type='individual',
    email='john@example.com',
    bank_account={
        'brand': 'bbl',
        'number': '1234567890',
        'name': 'JOHN DOE'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const recipient = await omise.recipients.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$recipient = OmiseRecipient::create([
    'name' => 'John Doe',
    'type' => 'individual',
    'email' => 'john@example.com',
    'bank_account' => [
        'brand' => 'bbl',
        'number' => '1234567890',
        'name' => 'JOHN DOE'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

BankAccount bankAccount = new BankAccount();
bankAccount.brand("bbl");
bankAccount.number("1234567890");
bankAccount.name("JOHN DOE");

Recipient recipient = client.recipients().create()
    .name("John Doe")
    .type("individual")
    .email("john@example.com")
    .bankAccount(bankAccount)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Create(new CreateRecipientRequest
{
    Name = "John Doe",
    Type = "individual",
    Email = "john@example.com",
    BankAccount = new BankAccount
    {
        Brand = "bbl",
        Number = "1234567890",
        Name = "JOHN DOE"
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

recipient, _ := client.Recipients().Create(&operations.CreateRecipient{
    Name:  "John Doe",
    Type:  "individual",
    Email: "john@example.com",
    BankAccount: &operations.BankAccount{
        Brand:  "bbl",
        Number: "1234567890",
        Name:   "JOHN DOE",
    },
})

---

エラーおよび結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	パラメータが欠落しているか無効です	すべての必須フィールドが提供されていることを確認してください
authentication_failure	無効なAPIキー	Secret keyが正しいことを確認してください
invalid_bank_account	銀行口座番号が無効です	口座番号が正しいことを確認してください
name_mismatch	口座名義が銀行記録と一致しません	銀行口座の正確な名義を使用してください
unsupported_bank	Recipientでサポートされていない銀行です	サポートされている銀行のリストを確認してください

Recipientタイプ

Type	Description
individual	個人銀行口座
corporation	法人/会社口座

---

Try it out

必須 - 5項目

▼

name(必須)

type(必須)

bank_account[brand](必須)

bank_account[number](必須)

bank_account[name](必須)

推奨 - 2項目

▼

追加 - 2項目

▼