Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
Login
Pay-Doc Pay-Doc
Login
Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
loading
  1. Home
  2. APIリファレンス
  3. 一般
  4. ページネーション
Updated on 2025年4月15日

APIリファレンス

  • Folder icon closed Folder open icon一般
    • API連携、SDKについて
    • 認証
    • APIの制限
    • レスポンス
    • ページネーション
    • メタデータ
    • ポーリング
    • 冪等なリクエスト
    • 通貨と為替レート
  • Folder icon closed Folder open iconトランザクショントークン
    • トランザクショントークン – 概要
    • トランザクショントークン – リクエスト
      • トランザクショントークン – CREATE
      • トランザクショントークン – GET
      • トランザクショントークン – LIST
      • トランザクショントークン – UPDATE
      • トランザクショントークン – DELETE
      • トランザクショントークン – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon課金
    • 課金 – 概要
    • 課金 – リクエスト
      • 課金 – CREATE
      • 課金 – GET
      • 課金 – GET(銀行振込)
      • 課金 – LIST
      • 課金 – UPDATE
      • キャプチャ – CREATE
      • イシュアトークン – GET
      • 課金 – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon定期課金
    • 定期課金 – 概要
    • 定期課金 – リクエスト
      • 定期課金 – CREATE
      • 定期課金 – GET
      • 定期課金 – LIST
      • 定期課金 – UPDATE
      • 定期課金 – CANCEL
      • 定期課金 – 課金 – LIST
      • 支払い – 概要
      • 支払い – GET
      • 支払い – LIST
  • Folder icon closed Folder open icon返金
    • 返金 – 概要
    • 返金 – リクエスト
      • 返金 – CREATE
      • 返金 – GET
      • 返金 – LIST
      • 返金 – UPDATE
  • Folder icon closed Folder open iconキャンセル
    • キャンセル – 概要
    • キャンセル – リクエスト
      • キャンセル – CREATE
      • キャンセル – GET
      • キャンセル – LIST
      • キャンセル – UPDATE
  • Folder icon closed Folder open iconトランザクション
    • トランザクション – 概要
    • トランザクション – リクエスト
      • トランザクション – LIST
  • Folder icon closed Folder open icon加盟店
    • 加盟店 – 概要
    • 加盟店 – リクエスト
      • 加盟店 – GET
  • Folder icon closed Folder open icon店舗
    • 店舗 – 概要
    • 店舗 – リクエスト
      • 店舗 – GET
      • 店舗 – LIST
      • カスタマーUUID
  • Folder icon closed Folder open icon決済設定
    • 決済設定 – 概要
    • 決済設定 – リクエスト
      • 決済設定 – GET
  • Folder icon closed Folder open iconウェブフック
    • ウェブフック – 概要
    • ウェブフック – リクエスト
      • ウェブフック – GET
      • ウェブフック – UPDATE
  • Folder icon closed Folder open iconエラーコード
    • エラーコード – 概要
  • Folder icon closed Folder open icon3-DセキュアをAPIで実装する
    • 3-Dセキュア認証の処理の流れ
    • 実装方法
    • 追加されるパラメータ
    • 3-Dセキュア認証情報を自社で取得している場合の対応

ページネーション

リストとして返されるすべてのリソースはページネートされリソースの作成日の降順でソートされます。
ページあたりのアイテムの件数はデフォルトで10件です。

ページネートされたリストの形式

  • items(array):リソースのリスト
  • has_more(boolean):表示されているリストの最後のリソースの次に更にリソースがあるかどうか
{
  "items": [],
  "has_more": false
}

次ページのリソースの取得

以下のパラメータを指定することでリストの次のページを取得することが可能です。

  • limit(number):10–100の範囲の整数で返却するリソースの数
  • cursor(string):リソースの取得開始位置を指定する為のリソースのID
             このリソースの次のリソースから取得され、このIDで指定したリソースはレスポンスには含まない
  • cursor_direction:リソースのソート順で、asc (昇順) もしくは desc (降順)

例えば、以下のリクエストで最初の100個の課金(Charge)リソースを取得することができます。

curl -h 'Authorization: Bearer {secret}.{jwt}' https://api.univapay.com/charges?limit=100
{
  "items": [
    {
      "id": "4050058b-646a-4fae-8876-babf0dc0c3f0"
      ...
    },
    ...
    {
      "id": "34daac6d-63a8-485b-a9ea-75a2e24a258d"
      ...
    }
  ],
  "has_more": true
}

"has_more":true となっているのでさらにリソースがある事がわかります。
次の100件の課金を取得するには、リストの最後のリソースID34daac6d-63a8-485b-a9ea-75a2e24a258dをリクエストパラメータのcursorとして指定します。

curl -h 'Authorization: Bearer {secret}.{jwt}' https://api.univapay.com/charges?cursor=34daac6d-63a8-485b-a9ea-75a2e24a258d&limit=100
Share this Doc

ページネーション

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.