Transferの取得

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

IDを使用して特定のtransferの詳細を取得します。ステータス、金額、recipient情報、タイムスタンプを含むtransferオブジェクトが返されます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

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

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

返されるtransfer属性:

• id - Transfer識別子
• amount - 最小通貨単位でのtransfer金額
• currency - 3文字のISO 4217通貨コード
• recipient - RecipientオブジェクトまたはID
• bank_account - 送金先銀行口座の詳細
• sent、paid - ステータスインジケータ
• created_at、sent_at、paid_at - タイムスタンプ

401

認証されていません

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

一般的な原因:

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

404

見つかりません

Transferが見つかりません。

一般的な原因:

• 無効なtransfer ID
• Transferがアカウントに属していません
• Transferが削除されています
• テストモードとライブモードのIDを混在させています

---

Code samples

cURL

curl https://api.omise.co/transfers/trsf_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const transfer = await omise.transfers.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');

Java

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

Transfer transfer = client.transfers()
    .get("trsf_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Get("trsf_test_5xuy4w91xqz7d1w9u0t");

Go

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

transfer, _ := client.Transfers().Get("trsf_test_5xuy4w91xqz7d1w9u0t")

---

Try it out

必須 - 1項目

▼

id(必須)