スマレジ・アプリ・カスタムURL Scheme仕様書 (ver.1.1.3)

株式会社スマレジ: smaregi@smaregi.jp URL: https://smaregi.jp Terms of Service

スマレジ・アプリと外部アプリ間のURL Schemeを利用した決済連携における仕様を記載します。

外部アプリ起動

{scheme}://{host}

スマレジ・アプリから外部アプリを起動する際に呼び出される。

path Parameters
scheme
required
string

外部アプリ起動時に使用するスキーム。

host
required
string

外部アプリ起動時に使用するホスト名。

query Parameters
operation
required
string
Enum: "pay" "void" "refund"

実行する処理の種類。

  • pay: 支払。
  • void: 取消。
  • refund: 返品。取消と区別する必要がない場合は取消と同様に処理する。
callback
required
string

外部アプリでの処理終了後に呼び出すURL。

slipNumber
required
string

決済識別子(UUID)。決済を一意に判断するために用いる。

  • 支払[pay]の時に指定した識別子は外部アプリ側で保存する。
  • 取消[void]・返品[refund]の時に取消・返品対象の識別子を指定し、一致する決済を取消・返品する。
price
required
number <double>

決済金額(円)。

  • 支払[pay]の時は外部アプリで決済したい金額。
  • 取消[void]・返品[refund]の時は取消・返品したい金額(一部返金には対応していないため決済時の金額と一致しない場合は失敗とする)。
required
object (取引)

取引。JSONで渡される。

Responses

スマレジ・アプリ起動

{callback}

外部アプリで決済完了後に呼び出す。

path Parameters
callback
required
string

リクエスト時のパラメータcallbackに指定したURL。

query Parameters
result
required
integer
Enum: 0 1

決済結果。

  • 0: 失敗
  • 1: 成功
message
required
string

決済が失敗した時に画面に表示するメッセージ。

決済が失敗した時のみ必須。

slipNumber
required
string

決済識別子。

リクエスト時のパラメータslipNumberをそのまま返す。リクエスト時と一致しない場合はエラーになる。

決済が成功した時のみ必須。

price
required
number <double>

実際に決済を行った金額。

お釣り等がある場合は受領した金額ではなく決済された金額を指定する。複数の決済方法を使用した場合は合計金額を指定する。

リクエスト時のパラメータpriceと異なる場合はエラーになる。

決済が成功した時のみ必須。

Array of objects (支払情報)

決済情報。JSONで渡す。

決済方法を区別する必要がある場合または複数の決済方法を利用した場合は指定する。

Responses