APIの仕様変更について

Paidy APIに関する最新情報を随時こちらのページでお知らせします。

  • 下位互換性のある変更をAPIに加える際は、現行のバージョンのAPIを修正する形でリリースを行います。つまり、例えばオブジェクトに(任意の)フィールドを追加したり、APIのエンドポイントやWebhookイベントを新たに増やしたりする場合がありますが、そういった変更によって既存のプログラムが動作しなくなることはありません。
  • 下位互換性のない変更(例えば現行のフィールドの仕様を改めるなどといった、既存のコードを修正する必要がある変更)は、APIをバージョンアップする際にのみ加えられます。

新しいバージョンのAPIをリリースする際は、こちらのページで重要な詳細情報をお伝えします。さらに、オンラインドキュメントが修正・加筆された際は、このセクションで変更内容をお伝えします。

それにつきまして、マーチャントの皆様には必ずPaidy APIの仕様に従ってコーディングを行うようお願い申し上げます。リリース済みの機能を改善するために、新しいバージョンのAPIに後から変更が加えられる可能性があります。仕様に従わずにコーディングを行った場合、この変更によりリクエストが上手くいかなくなるおそれがありますので、ご注意ください。



2017-08-04のドキュメントの更新
2017-04-24のドキュメントの更新
2017-03-31のドキュメントの更新
2017-03-06のドキュメントの更新
2016-07-01のバージョン

2017-08-04のドキュメントの更新

  • TLSの互換性についての情報を追加しました。
  • APIライブラリについての情報を削除された箇所。

2017-04-24のドキュメントの更新

  • トークンについての情報を追加しました。

2017-03-31のドキュメントの更新

  • Paidy Checkoutのペイロードに含めて送信する配送先オブジェクトについての記載を修正しました。このオブジェクトは必須項目です。

2017-03-06のドキュメントの更新

  • 注文商品オブジェクトのdescriptionフィールドとtitleフィールドに関する内容を加えました。
  • ブラウザ対応状況についての情報を追加しました。
  • 注文商品オブジェクト内に値引きを実装する方法を追加しました。

2016-07-01のバージョン

このバージョンでも以下のAPIリクエストがサポートされています。

  • 請求を完了させて支払いを回収できます。
  • 回収(Capture)した金額の一部または全額を払い戻せます。
  • 決済の詳細情報を取得することができます。
  • 決済データのorder_ref、description、metadataフィールドを更新できます。
  • Authorize済みでCaptureが完了していない決済をクローズできます。

特徴

  • APIで4つのキーを使用するようになりました。今後はテスト環境、運用時にそれぞれ別の秘密鍵と公開鍵を使用します。
  • APIのエンドポイントを表すURIにPayment IDを含めるようになりました。 それに伴い、今後はPayment IDをAPIリクエストのパラメーターとして送信していただく必要はありません。エンドポイントの新しいURIは以下の通りです。
    • /payments/{id}/captures
    • /payments/{id}/refunds
    • /payments/{id}/close
    • /payments/{id}
  • 決済オブジェクト、capturesオブジェクト、refundsオブジェクトに任意項目のmetadataフィールドが追加されました。マーチャントは自分で定義した決済に関する補足的なデータをこのフィールドに保存できます。
  • API v2でもorder_refフィールドは必須項目ではありません。また、一意の値を指定する必要もありません。