入金一覧を入金予定日でフィルタする機能を追加いたしました

平素はPAY.JPをご利用いただき誠にありがとうございます。

今回、入金一覧APIに引数を追加致しましたのでお知らせ致します。

これまで、入金一覧APIの結果を絞り込むには入金オブジェクト作成日を対象としたsince/untilパラメータによる絞り込みしか方法がありませんでしたが、このたび入金予定日を対象として絞り込みができる since_scheduled_date / until_scheduled_date パラメータを追加いたしました。

影響範囲

既存加盟店様への影響はございません。
新規に追加された引数をご利用になられる場合は最新のSDKにて引数を指定してください。

変更内容

対象エンドポイントは下記になります。

GET /v1/transfers
GET /v1/tenant_transfers

これらのエンドポイントに下記引数を追加致しました。

  • since_scheduled_date
    • 入金予定日が指定したタイムスタンプ以降のデータのみ取得
  • until_scheduled_date
    • 入金予定日が指定したタイムスタンプ以前のデータのみ取得

リクエスト例

  • 2021年4月以降入金予定のデータが取得したい場合
# 4/1 0時JSTのUNIXタイムスタンプを指定する
curl https://api.pay.jp/v1/transfers?since_scheduled_date=1617202800 \
-u sk_test_c62fade9d045b54cd76d7036:
  • 2021年4月より前の入金予定のデータが取得したい場合
# 4/1 0時JSTのUNIXタイムスタンプを指定する
curl https://api.pay.jp/v1/transfers?until_scheduled_date=1617202800 \
-u sk_test_c62fade9d045b54cd76d7036:
  • 2021年4月入金予定のデータが取得したい場合
# untilに5/1 0時JST、sinceに4/1 0時JSTのUNIXタイムスタンプを指定する
curl https://api.pay.jp/v1/transfers?until_scheduled_date=1619794800&since_scheduled_date=1617202800 \
-u sk_test_c62fade9d045b54cd76d7036:

scheduled_dateのタイムゾーンについて

現在のPAY.JPは日本国内でのみサービスを提供しており、集計期間や入金予定日の計算は日本時間で行われます。
その為scheduled_dateにつきましては日本時間の入金予定日(半月締めであれば15日、月末締めであれば翌月末日)のJST0時となります為、ご注意ください。

SDKのアップデートについて

下記言語のSDKに関しては当機能追加の対応を本日更新致しましたので、お使いの際はアップデートをお願い致します。

  • payjp-go
  • payjp-node

今後ともPAY.JPをどうぞよろしくお願いいたします。