Recipientを作成する

POSThttps://api.omise.co/recipients

Omise残高から送金を受け取るための銀行口座情報を持つ新しいRecipientを作成します。Recipientは個人または法人として設定できます。

---

リクエストパラメータ

必須 - 5フィールド必須パラメータ

▼

`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"

推奨 - 2フィールド推奨パラメータ

▼

追加 - 2フィールド追加パラメータ

▼

---

レスポンス

200

成功

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

返されるRecipient属性:

• object - "recipient"という値
• id - Recipient識別子（recp_*）
• livemode - ライブモードまたはテストモード
• location - Recipientオブジェクトへのパス
• activated_at - 有効化タイムスタンプ（ISO 8601）
• active - Recipientが有効かどうか
• bank_account - 送金先銀行口座オブジェクト
• created_at - 作成タイムスタンプ（ISO 8601）
• default - Recipientがアカウントのデフォルトかどうか
• deleted - Recipientが削除されたかどうか
• description - Recipientの説明
• email - Recipientのメールアドレス
• failure_code - 失敗理由コード（name_mismatch, account_not_found, bank_not_found）
• metadata - カスタムメタデータ
• name - Recipient名
• schedule - 送金スケジュール（展開可能）
• tax_id - Recipientの納税者番号
• type - Recipientタイプ（individual, corporation）
• verified - Recipientが確認済みかどうか
• verified_at - 確認タイムスタンプ（ISO 8601）

400

不正なリクエスト

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

一般的な原因:

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

401

認証エラー

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式が不正

422

処理不可

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

一般的な原因:

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

5xx

サーバーエラー

サーバー側でエラーが発生しました。これは稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

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",
    },
})

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータが欠落または無効	すべての必須フィールドが提供されているか確認
authentication_failure	APIキーが無効	シークレットキーが正しいか確認
invalid_bank_account	銀行口座番号が無効	口座番号が正しいか確認
name_mismatch	口座名義が銀行記録と一致しない	銀行口座の正確な名前を使用
unsupported_bank	Recipientでサポートされていない銀行	サポート銀行リストを確認

Recipientタイプ

タイプ	説明
individual	個人の銀行口座
corporation	企業/法人口座

---

🔑API認証情報

▼

試してみる

必須 - 5項目

▼

name(必須)

type(必須)

bank_account[brand](必須)

bank_account[number](必須)

bank_account[name](必須)

推奨 - 2項目

▼

追加 - 2項目

▼

あなたのIP: ...読み込み中...