Recipientを更新する

PATCHhttps://api.omise.co/recipients/:id

名前、メール、説明、メタデータを含むRecipientの詳細を更新します。銀行口座情報は更新できないことに注意してください。

---

リクエストパラメータ

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

▼

`id`STRING(required)

Recipient ID（例：recp_test_...）。URLパスで指定します。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

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

▼

`name`STRING(optional)

更新されたRecipient名。

Example:"John Smith"

`email`STRING(optional)

更新されたメールアドレス。

Example:"john.smith@example.com"

`description`STRING(optional)

更新された説明。

Example:"Marketplace seller - Premium"

`metadata`OBJECT(optional)

更新されたメタデータ（既存のメタデータを完全に置き換えます）。

Example:{"seller_id":"SELL-12345","tier":"premium"}

---

レスポンス

200

成功

Recipientが正常に更新されました。更新されたRecipientオブジェクトを返します。

返される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

不正なリクエスト

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

一般的な原因:

• 無効なメール形式
• 不正なmetadata形式
• metadataが15,000文字を超過

401

認証エラー

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

一般的な原因:

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

404

見つかりません

Recipientが見つかりません。

一般的な原因:

• 無効なRecipient ID
• Recipientがアカウントに属していない
• Recipientが削除された
• テストモードとライブモードのIDを混同

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Smith" \
  -d "email=john.smith@example.com"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.name = 'John Smith'
recipient.email = 'john.smith@example.com'
recipient.update()

Node.js

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

const recipient = await omise.recipients.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
});

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->update([
    'name' => 'John Smith',
    'email' => 'john.smith@example.com'
]);

Java

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

Recipient recipient = client.recipients()
    .update("recp_test_5xuy4w91xqz7d1w9u0t")
    .name("John Smith")
    .email("john.smith@example.com")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Update("recp_test_5xuy4w91xqz7d1w9u0t", new UpdateRecipientRequest
{
    Name = "John Smith",
    Email = "john.smith@example.com"
});

Go

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

recipient, _ := client.Recipients().Update("recp_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateRecipient{
    Name:  "John Smith",
    Email: "john.smith@example.com",
})

---

重要事項

• 銀行口座情報は更新できません
• 銀行口座を変更するには、Recipientを削除して新しく作成してください
• metadataパラメータは既存のメタデータを完全に置き換えます
• 既存のメタデータを保持するには、先にRecipientを取得してマージしてください

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

追加 - 4項目

▼

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