Recipientの取得

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

verification状態とbank account情報(セキュリティのためマスクされています)を含む、特定のrecipientの詳細を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

成功

Recipientが正常に取得されました。すべての属性を含む完全なrecipientオブジェクトを返します。

返されるrecipientの属性:

• id - Recipient識別子
• verified - Bank accountがverifyされているかどうか
• active - Recipientが送金を受け取れるかどうか
• name, email, type - Recipientの詳細
• bank_account - 銀行の詳細(口座番号はマスクされています)
• metadata - カスタムmetadata

401

認証されていません

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

一般的な原因:

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

404

見つかりません

Recipientが見つかりません。

一般的な原因:

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

---

Code samples

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

Try it out

必須 - 1項目

▼

id(必須)