Receiptを取得

GEThttps://api.omise.co/receipts/:receipt_id

識別子で特定のReceiptの詳細を取得します。手数料の内訳を含む完全なReceiptオブジェクトを返します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`receipt_id`STRING(required)

パターン/rcpt(_test)?_[0-9a-z]+/に一致するReceipt識別子。これはURLパスで提供されます。

Example:"rcpt_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なReceipt IDである必要があります

---

レスポンスs

200

取得成功

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

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

• id - Receipt識別子
• charge_fee - 累積された課金手数料
• transfer_fee - 累積された転送手数料
• total - 合計手数料額
• currency - 通貨コード
• created_at - 作成タイムスタンプ

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なシークレットキー
• シークレットキーの代わりに公開キーを使用している
• HTTP Basic Auth形式が正しくない

404

見つかりません

提供されたIDでReceiptが見つかりませんでした。

一般的な原因:

• 無効なReceipt ID形式
• Receiptが存在しない
• Receiptが別のアカウントに属している
• 本番Receipt IDでテストキーを使用している（またはその逆）

---

コードサンプル

cURL

curl https://api.omise.co/receipts/rcpt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipt = Omise::Receipt.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipt = omise.Receipt.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const receipt = await omise.receipts.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$receipt = OmiseReceipt::retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t');

Java

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

Receipt receipt = client.receipts().get("rcpt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var receipt = await client.Receipts.Get("rcpt_test_5xuy4w91xqz7d1w9u0t");

Go

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

receipt, _ := client.Receipts().Get("rcpt_test_5xuy4w91xqz7d1w9u0t")

---

エラーおよび結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	Receiptが見つかりません	Receipt IDが正しく存在することを確認してください
invalid_receipt_id	不正なReceipt ID	IDがrcpt(test)?[0-9a-z]+の形式に一致することを確認してください

Receiptオブジェクトのフィールド

フィールド	タイプ	説明
object	string	常に「receipt」を返します
id	string	一意のReceipt識別子
livemode	boolean	本番環境とテスト環境のインジケーター
charge_fee	integer	最小通貨単位でのOmise課金手数料
transfer_fee	integer	最小通貨単位での転送手数料
subtotal	integer	税引前小計
vat	integer	VAT額
wht	integer	源泉徴収税額
total	integer	subtotal + vat - whtとして計算された合計
currency	string	3文字のISO 4217コード
created_at	string	作成タイムスタンプ（ISO 8601）

---

試してみる

必須 - 1項目

▼

receipt_id(必須)