refundの取得

GEThttps://api.omise.co/charges/:charge_id/refunds/:refund_id

ステータス、金額、関連するトランザクションを含む、特定のrefundに関する詳細情報を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 2項目必須パラメータ

▼

`charge_id`STRING(required)

返金されたCharge ID（パスパラメータ）。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

`refund_id`STRING(required)

取得するRefund ID（パスパラメータ）。形式: rfnd_test_またはrfnd_live_の後に英数字文字列が続きます。

Example:"rfnd_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

成功した取得

ステータス、金額、タイムスタンプを含むすべての詳細を含むrefundオブジェクトを返します。

レスポンスに含まれるもの:

• id - refund ID
• status - 現在のrefundステータス（pending、successful、failed）
• amount - 最小通貨単位での返金額
• currency - 3文字のISO通貨コード
• charge - 関連するcharge ID
• transaction - refundのトランザクションID
• voided - refundがvoidとして処理されたかどうか
• metadata - refundに添付されたカスタムmetadata
• created_at - refund作成のISO 8601タイムスタンプ

401

認証されていません

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

一般的な原因:

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

404

見つかりません

refundまたはchargeが見つかりません。

一般的な原因:

• refund IDが正しくない
• charge IDが正しくない
• refundが別のchargeに属している
• refundまたはchargeが別のアカウントに属している
• IDのタイプミスまたは形式エラー

---

コードサンプル

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/refunds/rfnd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = Omise::Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', {
  charge: 'chrg_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = omise.Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t',
    charge='chrg_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const refund = await omise.refunds.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t', 'rfnd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$refund = OmiseRefund::retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', [
    'charge' => 'chrg_test_5xuy4w91xqz7d1w9u0t'
]);

Java

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

Refund refund = client.refunds().get("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Refunds.Get("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t");

Go

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

refund, _ := client.GetRefund("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t")

---

エラーおよび結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	secret keyが正しいことを確認してください
not_found	refundまたはchargeが見つからない	IDが正しいことを確認してください
invalid_refund_id	refund ID形式が無効	有効なrfnd_形式を使用してください

refundステータスコード

ステータス	説明
pending	refundが処理中
successful	refundが正常に完了
failed	refundが失敗（まれ）

---

試してみる

必須 - 2項目

▼

charge_id(必須)

refund_id(必須)