refundの作成

POSThttps://api.omise.co/charges/:id/refunds

成功した支払いに対して全額または一部返金を発行します。資金は自動的に顧客の元の支払い方法に返却されます。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

返金するCharge ID（パスパラメータ）。Chargeは成功、キャプチャ済み、返金可能である必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

推奨 - 1項目推奨パラメータ

▼

追加 - 2項目追加パラメータ

▼

---

レスポンス

200

成功したrefund

refundが正常に作成されました。処理状態を確認するにはstatusフィールドをチェックしてください。

可能なrefundステータス:

• pending - refundが処理中です。通常、顧客は5〜10営業日で資金を確認できます。
• successful - refundが正常に完了しました。
• failed - refundが失敗しました（まれ）。

400

不正なリクエスト

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

一般的な原因:

• 無効なcharge ID形式
• 返金可能残高を超える金額
• 無効なmetadata形式
• 最小値（1単位）を下回る金額

401

認証されていません

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

一般的な原因:

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

404

見つかりません

chargeが見つかりません。

一般的な原因:

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

422

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

chargeを返金できません。

一般的な原因:

• chargeが成功していない（保留中または失敗）
• chargeが既に全額返金済み
• 返金額が利用可能残高を超えている
• chargeに15回以上の部分返金がある（上限）
• chargeが365日以上前のもの（一部の支払い方法ではそれより短い）

---

コードサンプル

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/refunds \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=50000"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = Omise::Charge.refund('chrg_test_5xuy4w91xqz7d1w9u0t', {
  amount: 50000
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = omise.Charge.refund('chrg_test_5xuy4w91xqz7d1w9u0t',
    amount=50000
)

Node.js

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

const refund = await omise.charges.refund('chrg_test_5xuy4w91xqz7d1w9u0t', {
  amount: 50000
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$refund = $charge->refund([
    'amount' => 50000
]);

Java

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

Refund refund = client.charges().refund("chrg_test_5xuy4w91xqz7d1w9u0t")
    .amount(50000L)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Charges.Refund("chrg_test_5xuy4w91xqz7d1w9u0t", new CreateRefundRequest
{
    Amount = 50000
});

Go

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

refund, _ := client.CreateRefund(&operations.CreateRefund{
    ChargeID: "chrg_test_5xuy4w91xqz7d1w9u0t",
    Amount:   50000,
})

---

エラーおよび結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータが欠落または無効	すべての必須フィールドが提供されているか確認してください
authentication_failure	無効なAPIキー	secret keyが正しいことを確認してください
not_found	charge IDが存在しない	charge IDが正しいことを確認してください
charge_not_refundable	chargeを返金できない	chargeステータスが成功していることを確認してください
insufficient_refundable_amount	金額が利用可能残高を超えている	charge.amount - charge.refunded_amountを確認してください
too_many_refunds	既に15回のrefundが作成されている	chargeあたり最大15回の部分返金
refund_period_expired	chargeが返金期間を超えている	chargeは365日未満である必要があります

refundステータスコード

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

---

試してみる

必須 - 1項目

▼

id(必須)

推奨 - 1項目

▼

追加 - 2項目

▼