すべてのReceiptを一覧表示

GEThttps://api.omise.co/receipts

日次Receiptのページネーションされたコレクションを返します。Receiptはアカウントの取引および転送手数料を累積します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

---

レスポンスs

200

取得成功

Receiptリストが正常に取得されました。メタデータを含むページネーションされたリストを返します。

レスポンス構造:

• object - 常に「list」を返します
• data - Receiptオブジェクトの配列
• limit - ページごとのレコード数
• offset - スキップされたレコードの数
• total - フィルターに一致するReceiptの総数

401

認証されていません

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

一般的な原因:

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

---

コードサンプル

cURL

curl https://api.omise.co/receipts \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipts = Omise::Receipt.list(
  limit: 20,
  offset: 0
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipts = omise.Receipt.list(
    limit=20,
    offset=0
)

Node.js

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

const receipts = await omise.receipts.list({
  limit: 20,
  offset: 0
});

PHP

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

$receipts = OmiseReceipt::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Receipt> receipts = client.receipts().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var receipts = await client.Receipts.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

receipts, _ := client.Receipts().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
})

---

エラーおよび結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータが欠落または無効	パラメータの値と形式を確認してください
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
invalid_date_format	日付形式の検証に失敗	ISO 8601形式を使用してください（YYYY-MM-DDTHH:MM:SSZ）

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

フィールド	タイプ	説明
object	string	常に「receipt」を返します
id	string	/rcpt(_test)?_[0-9a-z]+/に一致するReceipt識別子
livemode	boolean	本番環境とテスト環境のインジケーター
charge_fee	integer	最小通貨単位でのOmise課金手数料
transfer_fee	integer	最小通貨単位での転送手数料
total	integer	subtotal + vat - whtとして計算されます
currency	string	3文字のISO 4217コード
created_at	string	ISO 8601形式のUTC日時

---

試してみる

追加 - 5項目

▼