Recipientの確認

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

Recipientのbank accountを手動で確認します。ほとんどのrecipientは作成時に自動的に確認されるため、このエンドポイントは主にテスト目的で使用されます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

成功

Recipientが正常にverifyされました。verified: trueを含む更新されたrecipientオブジェクトを返します。

Verificationの属性:

• verified - verification成功後にtrueに設定されます
• verified_at - Verificationが完了したタイムスタンプ
• failure_code - Verification成功時はnull
• Recipientは送金を受け取れるようになります

401

認証されていません

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

一般的な原因:

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

404

見つかりません

Recipientが見つかりません。

一般的な原因:

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

422

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

Verificationに失敗したか、recipientはすでにverifyされています。

一般的な原因:

• Recipientはすでにverifyされている
• Bank accountのverificationに失敗した
• Bank accountの詳細が無効

---

Code samples

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t/verify \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.verify('recp_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.verify('recp_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const recipient = await omise.recipients.verify('recp_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->verify();

Java

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

Recipient recipient = client.recipients()
    .verify("recp_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Verify("recp_test_5xuy4w91xqz7d1w9u0t");

Go

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

recipient, _ := client.Recipients().Verify("recp_test_5xuy4w91xqz7d1w9u0t")

---

重要な注意事項

• ほとんどのrecipientは作成時に自動的にverifyされます
• このエンドポイントは主にテスト目的で使用されます
• Verifyされたrecipientはすぐに送金を受け取ることができます
• ライブモードでのverificationには通常1〜2営業日かかります
• テストモードでは、このエンドポイントを使用すると即座にverifyされます

---

Try it out

必須 - 1項目

▼

id(必須)