APIの仕様変更について

Paidy APIおよびオンライン・ドキュメントの更新情報を随時こちらのページでお知らせします。

こちらのページに掲載される更新情報は、次の3つのカテゴリーに分かれています。

  • オンライン・ドキュメントにのみ加筆・修正が加えられた場合は、ドキュメントの更新という形で情報を掲載します。
  • 後方互換性のある変更を既存のAPIに加えた場合は、リビジョンという形で情報を掲載します。後方互換性のある変更によって、マーチャントの既存のリクエストを処理できなくなることはありません。送信するリクエストに変更を加えずとも、後方互換性のある変更が加えられる前の段階で正常に処理されていたリクエストは、変更後も正常に処理されます。例えば、あるオブジェクトに(任意の)フィールドを追加したり、APIのエンドポイントを増やしたりするケースがこれに該当します。 また、リリース済みの機能を改善するためにAPIに変更が加えられることもあります。そのため、必ずPaidyのAPIの仕様に従ってコーディングを行うようにしてください。そうしなければ、変更によってリクエストが正常に処理されない場合があります。
  • 後方互換性のない変更(例えば、現行のフィールドの仕様を改めるなどといった、既存のコードを修正する必要がある変更)が必要になる場合もあります。この種の変更は、新しいバージョンのAPIとしてリリースされます。また、このような場合はリリースという形で情報を掲載し、新しいバージョンのAPIで利用できる各機能や、以前のAPIから変更された点などの情報を中心にお伝えします。



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

2017-10-24のリビジョン

  • 決済オブジェクトにtierという任意のフィールドが追加されました。APIリクエストが成功した場合、このフィールドを含むレスポンスが返されます。 Paidyは新しい種類のサービスや決済方法を導入するために、継続的に作業に取り組んでいます。今後、そのような新機能が追加され次第、このフィールドを使って機能を指定していくことになります。従来のPaidy決済はPaidy Classicと呼ばれるようになり、既存の決済の場合、このフィールドには「classic」という初期値が指定されるようになります。

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

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

2017-04-24のリビジョン

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

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

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

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

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

2016-07-01のバージョン

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

  • 決済のCapture: コンシューマーに請求する準備が整っていれば、支払いを回収できます。
  • 決済のRefund: 回収した金額の一部または全額を払い戻せます。
  • 決済データの取得(Retrieve): 決済オブジェクトを取得できます。
  • 決済のUpdate: 決済オブジェクトのorder_ref、description、metadataフィールドを更新できます。
  • 決済のClose: 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フィールドが追加されました。マーチャントは自分で定義した決済に関する補足的なデータを20のkey-valueペアを上限としてmetadataに保存できます。
  • API v2でもorder_refフィールドは必須項目ではありません。また、一意の値を指定する必要もありません。