APIの仕様変更について

ペイディAPIおよびオンライン・ドキュメントの更新情報を随時こちらのページでお知らせします。こちらのページに掲載される更新情報は、次の3つのカテゴリーに分かれています。

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

2024-09-19のドキュメントの更新

Webhookのサポートされているイベントの種類の説明を追加しました。
delivery_locn_typeフィールドの説明を更新し、可能の値に"not_primary_home"を追加しました。
決済作成リクエストへのレスポンスの403 authorization.failedと、Refundリクエストへのレスポンスの403 service.forbiddenの説明を更新しました。

2024-07-25のドキュメントの更新

トークン用Paidy Checkoutのコールバック関数として「on_close」を追加しました。

2023-02-20のドキュメントの更新

支払手数料を更新しました（ブランドガイドライン・特定商取引法）。

2022-08-26のドキュメントの更新

Paidy Checkoutのリクエストの「logo_url」、「days_since_first_transaction」、「last_order_amount」、「last_order_at」、「last_order_date」フィールドを更新しました。
ブラウザとOSの互換性に関する情報を更新しました。

2022-03-25のドキュメントの更新

iOSの互換性に関する情報を更新しました。
ブランドガイドラインのバナーを更新しました。
サイトデザインを更新しました。

2021-11-01のドキュメントの更新

buyer_dataオブジェクトについて、「subscription_counter」と「number_of_points」のフィアルドを更新しました。
ペイディランディングページのダウンロードファイルを更新しました。

2021-09-22のドキュメントの更新

ペイディロゴとブランディング項目を更新しました。

2021-05-13のリビジョン

トークンのoriginオブジェクトについて、加盟店がbuyerオブジェクトにセットした内容をレスポンスするように修正しました。これまではコンシューマーがCheckoutアプリケーション内で登録した内容がレスポンスされていました。

2021-04-21のドキュメントの更新

ブランディング項目を更新しました。
iOSの互換性に関する情報を更新しました。

2021-03-01のドキュメントの更新

ブランディング項目を更新しました。

2020-12-03のドキュメントの更新

「特定商取引法の記載について」のページを更新しました。
ブランディング項目のバナーを更新しました。

2020-07-30のドキュメントの更新

Paidy CheckoutのTLSバージョンを更新しました。
配送先フィールドの説明を更新しました。
ブラウザとOSの互換性に関する情報を更新しました。

2019-11-29のドキュメントの更新

コンビニ支払手数料を更新しました。

2019-09-24のドキュメントの更新

Webhookの送信元IPアドレスの一覧を更新しました。

2018-12-14のドキュメントの更新

metadataというフィールドを修正しました（データ型はobjectです）。

2018-11-29のリビジョン

弊社はセキュリティ向上に一貫して取り込んでおります。このたび、セキュリティ対策として、Paidy Checkoutにおける通信においてTLS1.0およびTLS1.1をサポート対象外とし、TLS1.2以上をサポート対象といたします。
buyerオブジェクトのname1というフィールドを訂正しました（name1は必須項目です）。

2018-11-08のドキュメントの更新

ブラウザとOS対応状況についての情報を更新しました。

2018-09-28のドキュメントの更新

Webhookの通知で生じる遅延と再試行に関するセクションを更新しました。
リクエスト（決済開始とトークン作成）のペイロードに含めるemailフィールドとphoneフィールドを「任意フィールド」に変更しました。これらのフィールドがペイロードに含まれている場合、Paidy Checkoutアプリケーションが起動する際にフィールドが自動入力されます。これらのフィールドがペイロードに含まれていない場合は、チェックアウトを行う際にコンシューマーが自身で入力を行う必要があります。

2018-07-06のリビジョン

buyer_dataオブジェクトにuser_idという任意のフィールドが追加されました。

2018-06-29のドキュメントの更新

Webhook失敗時の再試行回数を訂正しました（システムは最大15回、通知を再送信しようと試みます）。
「特定商取引法の記載」を追加しました。

2018-04-10のバージョン

このバージョンのAPIには、今後ペイディがマーチャント単位で提供する予定である新しい種類の決済をサポートするために必要な変更が含まれています。

改善されたサービスや各種機能を活用するために、マーチャントは最新バージョンのAPIを使用することが推奨されます。このバージョン番号はAPIリクエストを行う毎にヘッダーで指定できます。バージョン2016-07-01を使用しているマーチャントは正しく実装を行っている限り、各リクエストのヘッダーに含めるバージョン番号を除いて、実装済みのコードを変更する必要は一切ありません。マーチャントはこちらのバージョンのAPIを使うことが推奨されますが、以前のバージョンのAPI（バージョン2016-07-01）も引き続きサポートされます。

2018-03-29のドキュメントの更新

Paidy Checkoutからコールバック関数によって返されるtoken IDのパラメーター名が修正されました。

2017-10-24のリビジョン

決済オブジェクトにtierという任意のフィールドが追加されました。APIリクエストが成功した場合、このフィールドを含むレスポンスが返されます。ペイディは新しい種類のサービスや決済方法を導入するために、継続的に作業に取り組んでいます。今後、そのような新機能が追加され次第、このフィールドを使って機能を指定していくことになります。従来の決済は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フィールドは必須項目ではありません。また、一意の値を指定する必要もありません。