Refund（課金の払い戻し）

Refunds（課金の払い戻し）は、過去に作成した課金オブジェクトの払い戻し処理を行います。払い戻された金銭は課金請求をしたクレジットカードに対して行われます。一部金額を払い戻すこともできます。一度行った払い戻しは、一部払い戻しであっても取り消せません。

Attributes

Name	Type	Description
object	string	固定値`refund`。
id	string	`/rfnd(_test)?_[0-9a-z]+/`に一致する`REFUND_ID`。
livemode	boolean	本番モード (`true`) あるいはテストモード(`false`) の返金。
location	string	現在の`refund`オブジェクトを取得するためのAPIパス。
acquirer_reference_number	string	加盟店が行った返金の参照番号です。この情報は、VisaおよびMastercardに向けた決済レポートの一部として送信されます。
amount	integer	smallest currency unit（最小通貨単位）での返金額。
approval_code	string	TBD
charge	object_id_expandable	返金に紐づく`Charge ID`。
created_at	string	ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`)で返金が作成されたUTC日時。
currency	string	3文字で表示される返金用通貨ISO 4217 コード。
funding_amount	integer	`funding_currency`（`currency` != `funding_currency`の場合）と両替後に加盟店に支払われる金額を[最小通貨単位]（/currency-and-amount）で表したもの。
funding_currency	string	`funding_amount`の通貨
merchant_name	string	返金を実行したサブマーチャントの名前です。注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。
merchant_uid	string	返金を実行したサブマーチャントのIDです。注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。
metadata	object	返金のためのカスタムメタデータ（例:`{"customer-id": 42}`) 。
status	string	返金のステータス。
terminal	string	Original charge point of sale within a branch.
transaction	object_id_expandable	返金された`TRANSACTION_ID`。
voided	boolean	返金が無効化されているかどうか。

Example

JSON Response

{
  "object": "refund",
  "id": "rfnd_test_no1t4tnemucod0e51mo",
  "location": "/charges/chrg_test_no1t4tnemucod0e51mo/refunds/rfnd_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "voided": false,
  "currency": "THB",
  "amount": 10000,
  "metadata": {
    "answer": 42
  },
  "charge": "chrg_test_no1t4tnemucod0e51mo",
  "terminal": null,
  "transaction": "trxn_test_no1t4tnemucod0e51mo",
  "status": "closed",
  "funding_amount": 10000,
  "funding_currency": "THB",
  "created_at": "2019-12-31T12:59:59Z"
}

新しい課金の払い戻しを作成

- POST https://api.omise.co/charges/{id}/refunds

新しい課金の払い戻しを作成し、そのRefundオブジェクトを返します。

Request Parameters

Name	Type	Description
amount	integer	(必須) smallest currency unit（最小通貨単位）での返金額。
metadata	object	(任意) 返金のためのカスタムメタデータ（例:`{"customer-id": 42}`) 。
void	boolean	(任意, one of: `true`, `false`) 任意：デフォルトはfalse、void のみを実施させるためのフラグ。もし void ができない場合、refund を行わない。

Example

新しい課金の払い戻しを作成

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/charges/chrg_test_5g5idked981unmzjzhl/refunds \
  -u $OMISE_SECRET_KEY: \
  -d "amount=10000"

<?php

$charge = OmiseCharge::retrieve("chrg_test_4xso2s8ivdej29pqnhz");
$refund = $charge->refunds()->create(array('amount' => 10000));

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

const charge = await omise.charges.createRefund(
  'chrg_test_no1t4tnemucod0e51mo',
  { amount: 10000 },
);
console.log(charge);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

charge = Omise::Charge.retrieve("chrg_test_4xso2s8ivdej29pqnhz")
refund = charge.refunds.create(amount: 10000)

var charge = RetrieveCharge();
var refund = await Client.Charge(charge.Id).Refunds.Create(new CreateRefundRequest
{
    Amount = charge.Amount,
});

Console.WriteLine($"created refund: {refund.Id}");

Request<Refund> request = new Refund.CreateRequestBuilder("chrg_test_4xso2s8ivdej29pqnhz")
        .amount(10000)
        .build();
Refund refund = client().sendRequest(request);

System.out.printf("Created refund: %s", refund.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

charge = omise.Charge.retrieve("chrg_test_no1t4tnemucod0e51mo")
refund = charge.refund(amount=10000)

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Recipient{}

err := client.Do(result, &operations.CreateRefund{
	ChargeID: "chrg_test_no1t4tnemucod0e51mo",
	Amount:   2000, // THB 1,000.00 or JPY 100,000
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.refund("chrg_test_4ype2jynk2len88i4er", amount: 10000)

Create a refund while adding metadata

curl
php
node.js

curl https://api.omise.co/charges/chrg_test_5g5idked981unmzjzhl/refunds \
  -u $OMISE_SECRET_KEY: \
  -d "amount=10000" \
  -d "metadata[order_id]=ORDER-1234" \
  -d "metadata[color]=black"

<?php

$charge = OmiseCharge::retrieve('chrg_test_6bp9e1mr40jni2imuan');
$refund = $charge->refunds()->create(array(
    'amount'   => 10000,
    'metadata' => array(
        'order_id' => 'ORDER_ID',
        'color'    => 'pink'
    )
));

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

const charge = await omise.charges.createRefund(
  'chrg_test_no1t4tnemucod0e51mo',
  { amount: 10000 },
  {
    metadata: {
      order_id: 'ord_test_no1t4tnemucod0e51mo',
      color: 'black',
    },
  },
);
console.log(charge);

払い戻しリストの取得

- GET https://api.omise.co/charges/{id}/refunds

refundに属するすべてのお客様のアカウントオブジェクトの list を返します。

Request Parameters

Name	Type	Description
from	string	(任意, default: `1970-01-01T00:00:00Z`) ISO 8601 形式(`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日時。
limit	integer	(任意, default: `20`) 返されるレコードの数。
offset	integer	(任意, default: `0`) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。
order	string	(任意, default: `chronological`, one of: `chronological`, `reverse_chronological`) listのオーダーが`chronological` (古い順) or `reverse_chronological` (新しい順)で返されます。エントリがない場合は `null`となります。
to	string	(任意) ISO 8601形式 (`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日付と時刻。

Example

特定の課金に関する払い戻し情報のリスト

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/charges/chrg_test_5g5idked981unmzjzhl/refunds \
  -u $OMISE_SECRET_KEY:

<?php

$charge = OmiseCharge::retrieve("chrg_test_4xso2s8ivdej29pqnhz");
$refunds = $charge->refunds();

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

const charge = await omise.charges.listRefunds('chrg_test_no1t4tnemucod0e51mo');
console.log(charge);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

charge = Omise::Charge.retrieve("chrg_test_4xso2s8ivdej29pqnhz")
refunds = charge.refunds

var chargeId = "chrg_test_58fkc7mrh99fnymu214";
var refunds = await Client
    .Charge(chargeId)
    .Refunds
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"refunds for this charge: {refunds.Total}");

Request<ScopedList<Refund>> request =
        new Refund.ListRequestBuilder("chrg_test_4xso2s8ivdej29pqnhz").build();
ScopedList<Refund> refunds = client().sendRequest(request);

System.out.printf("Total no. of refunds: %d", refunds.getTotal());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

charge = omise.Charge.retrieve("chrg_test_no1t4tnemucod0e51mo")
refunds = charge.refunds

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.RefundList{}

err := client.Do(result, &operations.ListRefunds{
	ChargeID: "chrg_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.list_refunds("chrg_test_4xso2s8ivdej29pqnhz")

払い戻しリストの取得

- GET https://api.omise.co/refunds

refundに属するすべてのお客様のアカウントオブジェクトの list を返します。

Request Parameters

Name	Type	Description
from	string	(任意, default: `1970-01-01T00:00:00Z`) ISO 8601 形式(`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日時。
limit	integer	(任意, default: `20`) 返されるレコードの数。
offset	integer	(任意, default: `0`) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。
order	string	(任意, default: `chronological`, one of: `chronological`, `reverse_chronological`) listのオーダーが`chronological` (古い順) or `reverse_chronological` (新しい順)で返されます。エントリがない場合は `null`となります。
to	string	(任意) ISO 8601形式 (`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日付と時刻。

Example

課金の払い戻しリストの取得

curl
node.js
ruby
C#
elixir

curl https://api.omise.co/refunds \
  -u $OMISE_SECRET_KEY:

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

const charge = await omise.charges.listRefunds('chrg_test_no1t4tnemucod0e51mo');
console.log(charge);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

refunds = Omise::Refund.list

var refunds = await Client
    .Refunds
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"refunds so far: {refunds.Total}");

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Refund.list

課金の払い戻し情報の取得

- GET https://api.omise.co/charges/{id}/refunds/{refund_id}

課金IDで指定したChargeオブジェクトにひも付くRefundオブジェクトを取得します。

Example

課金の払い戻し情報の取得

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/charges/chrg_test_5g5idked981unmzjzhl/refunds/rfnd_test_4zgf1d7jcw5kr123puq \
  -u $OMISE_SECRET_KEY:

<?php

$charge = OmiseCharge::retrieve("chrg_test_4xso2s8ivdej29pqnhz");
$refund = $charge->refunds()->retrieve("rfnd_test_4ypebtxon6oye5o8myu");

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

const charge = await omise.charges.retrieveRefund('chrg_test_no1t4tnemucod0e51mo', 'rfnd_test_no1t4tnemucod0e51mo');
console.log(charge);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

charge = Omise::Charge.retrieve("chrg_test_4xso2s8ivdej29pqnhz")
refund = charge.refunds.retrieve("rfnd_test_4zgf1d7jcw5kr123puq")

var chargeId = "chrg_test_58fkc7mrh99fnymu214";
var refundId = "rfnd_test_58fkcxsbyxodfei74kt";
var refund = await Client.Charge(chargeId).Refunds.Get(refundId);
Console.WriteLine($"refunded: {refund.Amount}");

Request<Refund> request =
        new Refund.GetRequestBuilder("chrg_test_4xso2s8ivdej29pqnhz", "rfnd_test_4ypebtxon6oye5o8myu")
                .build();
Refund refund = client().sendRequest(request);

System.out.printf("Refunded amount: %d", refund.getAmount());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

charge = omise.Charge.retrieve("chrg_test_no1t4tnemucod0e51mo")

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Refund{}

err := client.Do(result, &operations.RetrieveRefund{
	ChargeID: "chrg_test_no1t4tnemucod0e51mo",
	RefundID: "rfnd_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.retrieve_refund("chrg_test_4xso2s8ivdej29pqnhz", "rfnd_test_4zgf1d7jcw5kr123puq")