Points Code (1.0)

PayPayポイントコードAPIは、加盟店がポイントコード関連の操作を行い、エンドユーザーに最良の体験を提供するように設計されています。 PayPayクライアントとして登録されると、次の機能が提供されます。

• エンドユーザーへのポイントコード(チャージコード)の即時作成
• 予算残高の確認

本ドキュメントでは、上記の機能をサポートするAPIについて説明します。 なお、PayPay商品券コードも対応しており、ご利用される場合は、"ポイントコード"を"商品券コード"と読み替えてください。

• PayPayポイントコードサービス概要についてはこちら
  
• PayPay商品券の概要についてはこちら（ユーザー向けご説明ページ）

PayPay OPAの利用を開始するには、事前に定義されたプロセスに従って、PayPay加盟店として登録をしなければなりません。 このプロセスは、情報収集、手動検証、契約確認、およびクレデンシャル情報の発行から構成されます。 PayPayに加盟店が登録されると、加盟店用にOPAクライアントが作成され、以下の項目が設定されます。

• API keyとsecret
• 許可された認可コールバックドメイン
• クライアントIPホワイトリスト

これらの設定は、マーチャントパネルを使用して管理するか、または弊社営業担当までご連絡ください。 ポイントコードAPIでは、ポイントコードgroupIdの登録も必要です。加盟店はビジネス要件に応じて、複数のポイントコードgroupIdを持つことができます。 ポイントコードgroupIdの作成については、弊社営業担当による設定が必要です。 ユーザーからのPayPayアプリ、PayPayWeb画面への日本国外からのアクセスは制限されています。詳細については個別にご相談ください。

APIのリクエスト時に加盟店識別子をセットする必要があります。 加盟店識別子をセットするには2つの方法があります。

クエリの中にセットする:

?assumeMerchant={MerchantId}

HTTPヘッダにセットする:

X-ASSUME-MERCHANT: {MerchantId}

両方を指定した場合、クエリにセットしたパラメーターが優先されます。

OPA API認証に関わることは全て API認証のページ にあります。

PayPay OPAはhttpレスポンスステータスコードとOPAエラーコードを使用してリクエストの成功または失敗を示します。 これらの情報を使用して、どのようなエラー対応をするかを判断できます。 通常、PayPay OPAは以下のhttpレスポンスステータスコードを返します。

各API共通レスポンスコード

Create Points Code

基本的に、すべてのAPIレスポンスには X-REQUEST-ID がレスポンスヘッダーとして含まれます（一部例外を除きます）。 PayPayへお問い合わせの際は、このリクエストIDをご提示ください。

フォーマット: 英数字とハイフン（最大64文字）

例:

OPA45F681001AEF4605B2A50939F611F4B8