Markdownをコピー
ポイント API一覧
ポイントで利用するAPIの一覧です。
ポイントは OpenAPIタイプ でのみご利用いただけます。
ポイント認可
ポイントの利用・付与を行う前に、お客様のポイント口座と加盟店様の会員IDを紐づけます。
ポイント利用
- ポイント利用(
/point/use)API - 利用ポイント変更(
/point/change)API — 減額のみ。増額・同額変更はできません - ポイント利用取消(
/point/cancel)API — 全額取消のみ
ポイント付与
- ポイント付与(
/point/grant)API — 非同期処理 - ポイント付与取消(
/point/grantcancel)API — 非同期処理。全額取消のみ。やむを得ない場合のみ実施する例外的な操作です(制約事項と運用ルール)
ポイント照会
- ポイント取引照会(
/point/inquiry)API - ポイント残高照会(
/point/balance)API — PayPayポイントは非対応
Webhook通知
ポイント付与・付与取消の非同期処理の完了は、Webhook通知で受け取ります。
通知の受信仕様はWebhook通知を参照ください。
事業者別の対応状況
APIごとの対応ポイント事業者は以下の通りです。
| API | Pontaポイント | Vポイント | PayPayポイント |
|---|---|---|---|
| ポイント認可開始 | ○ | ○ | ○ |
| ポイント認可結果確認 | ○ | ○ | ○ |
| ポイント残高照会 | ○ | ○ | × |
| ポイント利用 | ○ | ○ | × |
| 利用ポイント変更 | ○ | ○ | × |
| ポイント利用取消 | ○ | ○ | × |
| ポイント付与 | ○ | ○ | ○ |
| ポイント付与取消 | ○ | ○ | ○ |
| ポイント取引照会 | ○ | ○ | ○ |
パラメーターの必須条件も事業者ごとに異なります。詳細は事業者別の仕様差異を参照ください。
事業者に依らない制約(取消の受付期限、付与取消で取り戻せる範囲など)は制約事項と運用ルールを参照ください。