スマレジ・アプリと外部アプリ間のURL Schemeを利用した決済連携における仕様を記載します。
*2024年2月1日より、スマレジ・アプリ カスタム URL Schemeを利用した決済連携アプリをご利用される場合において、端末連携が有料(月額1,320円(税込)/1台)となります。 連携費用についてはスマレジとスマレジユーザーとの契約となります。
スマレジ・アプリから外部アプリを起動する際に呼び出される。
scheme required | string 外部アプリ起動時に使用するスキーム。 |
host required | string 外部アプリ起動時に使用するホスト名。 |
contractId required | string 契約ID。 |
operation required | string Enum: "pay" "void" "refund" 実行する処理の種類。
|
callback required | string 外部アプリでの処理終了後に呼び出すURL。 |
slipNumber required | string 決済識別子 (UUID)。決済を一意に判断するために用いる。
|
price required | number <double> 決済金額 (円)。
|
required | object (取引) 取引。JSONで渡される。 |
外部アプリで決済完了後に呼び出す。
callback required | string リクエスト時のパラメータ |
result required | integer Enum: 0 1 決済結果。
|
message required | string 決済が失敗した時に画面に表示するメッセージ。 決済が失敗した時のみ必須。 |
slipNumber required | string 決済識別子。 リクエスト時のパラメータ 決済が成功した時のみ必須。 |
price required | number <double> 実際に決済を行った金額。 お釣り等がある場合は受領した金額ではなく決済された金額を指定する。複数の決済方法を使用した場合は合計金額を指定する。 リクエスト時のパラメータ 決済が成功した時のみ必須。 |
Array of objects (支払情報) 決済情報。JSONで渡す。 決済方法を区別する必要がある場合または複数の決済方法を利用した場合は指定する。 |