Markdownをコピー
リンクタイプ Plus インタフェース仕様（アトカラ）
概要
リンクタイプ Plusでは、アトカラを利用できます。
- アトカラを利用する場合は、実行パラメータセットにアトカラ固有の必要項目を渡してください。
URLの生成方法は3通りです。- 管理画面で生成：新規取引作成画面にて必要項目を入力してください。
- APIで生成：API呼び出し時にパラメータを指定してください。
- パラメータ型URL生成：パラメータ付きURLの生成時にパラメータを指定してください。
- 決済完了後は遷移先URLにアトカラの結果パラメータを返却します。
実行パラメータ仕様
アトカラ固有の実行パラメータは以下の通りです。
FullName~Birthdayの項目は決済画面に入力フォームが表示されています。各項目を設定した場合、リンクタイプ Plus画面表示時に初期値として表示されます。
加盟店様でお客様情報をお持ちで、お客様側での入力の手間を省きたい場合に各項目を設定してください。
| json key | 説明 | 必須 | 形式 | 加盟店デフォルト値※1の登録可否 | システム デフォルト値※2 |
|---|---|---|---|---|---|
atokara | アトカラ固有実行パラメータ（親要素） アトカラの実行パラメータセットです。 | — | — | — | — |
atokara.FullName | 氏名（漢字） お客様の氏名を指定できます。 | — | 全半角21桁 | ✖ | (null) |
atokara.FullKanaName | 氏名（カナ） お客様の氏名（カナ）を指定できます。 | — | 全角25桁 | ✖ | (null) |
atokara.ZipCode | 郵便番号 お客様の郵便番号を指定できます。 デジタルコンテンツを扱うショップ設定の場合、決済画面に入力フォームは表示されないため設定項目は無視されます。 | — | 半角数字記号8桁 | ✖ | (null) |
atokara.Address | 住所 お客様の住所を指定できます。 デジタルコンテンツを扱うショップ設定の場合、決済画面に入力フォームは表示されないため設定項目は無視されます。 | — | 全半角55桁 | ✖ | (null) |
atokara.CompanyName | 会社名 お客様の会社名を指定できます。 | — | 全半角30桁 | ✖ | (null) |
atokara.DepartmentName | 部署名 お客様の部署名を指定できます。 | — | 全半角30桁 | ✖ | (null) |
atokara.Tel1 | 携帯電話番号 お客様の携帯電話番号を指定できます。 | — | 半角数字記号14桁 | ✖ | (null) |
atokara.Tel2 | 固定電話番号 お客様の固定電話番号を指定できます。 | — | 半角数字記号14桁 | ✖ | (null) |
atokara.Email1 | メールアドレス お客様のメールアドレスを指定できます。 | — | 半角英数記号100桁 | ✖ | (null) |
atokara.Email2 | メールアドレス2 お客様のメールアドレス2を指定できます。 | — | 半角英数記号100桁 | ✖ | (null) |
atokara.Sex | 性別 以下のいずれかを設定します。 0：回答しない1：男性2：女性 | — | 半角数字1桁 | ✖ | (null) |
atokara.Birthday | 誕生日 お客様の誕生日を指定できます（yyyy/MM/dd形式）。 例：2025/02/18 | — | 半角数字記号10桁 | ✖ | (null) |
atokara.PaymentCount | 支払回数 分割払いの支払回数を指定できます。 注意 ・分割支払はアトカラ会員のみ利用可能です。 ・アトカラ会員ではないユーザーは、支払回数を2以上にすると決済できません。 ・決済するお客様がアトカラ会員であり、支払回数を固定化したい場合のみ設定してください。 | — | 半角数字3桁 | ✖ | (null) |
atokara.Details | 明細詳細情報 JSON形式で指定してください※3。最大15件まで指定可能です。 | — | — | ✖ | (null) |
atokara.DetailNameDetail | 明細詳細情報_明細名 商品の明細名を指定できます。 未指定の場合は、「ご利用代金(ml)」が設定されます。 | — | 全半角300桁 | ✖ | (null) |
atokara.DetailPriceDetail | 明細詳細情報_単価 商品の単価を指定できます。 未指定の場合は、共通パラメータの「利用金額+税送料」が設定されます。 共通パラメータについては「実行パラメータ項目(決済共通部)」をご覧ください。 | — | 半角数字6桁 | ✖ | (null) |
atokara.DetailQuantityDetail | 明細詳細情報_数量 商品の数量を指定できます。 未指定の場合は、「1」が設定されます。 | — | 半角数字5桁 | ✖ | (null) |
atokara.TransactionSn | 明細詳細情報_取引通番 商品の取引通番を指定できます。 | — | 全半角4桁 | ✖ | (null) |
atokara.DetailBrand | 明細詳細情報_ブランド 商品のブランドを指定できます。 | — | 全半角300桁 | ✖ | (null) |
atokara.DetailCategory | 明細詳細情報_カテゴリ 商品のカテゴリを指定できます。 | — | 全半角300桁 | ✖ | (null) |
※1 加盟店デフォルト値：設定IDに紐づけて加盟店様ごとに設定されたデフォルト値。ショップ管理画面で設定してください。都度のパラメータ指定がない場合に適用されます。
※2 システムデフォルト値：システムで設定されているデフォルト値。都度のパラメータ指定および加盟店デフォルト値がない場合に適用されます。
※3 明細詳細情報の設定例 明細詳細情報が1件の場合
{
"Details": [
{
"DetailNameDetail": "明細名",
"DetailPriceDetail": "1500",
"DetailQuantityDetail": "10",
"TransactionSn": "1",
"DetailBrand": "ブランド",
"DetailCategory": "カテゴリ"
}
]
}
明細詳細情報が複数件の場合
{
"Details": [
{
"DetailNameDetail": "明細名1",
"DetailPriceDetail": "1500",
"DetailQuantityDetail": "1",
"TransactionSn": "1",
"DetailBrand": "ブランド",
"DetailCategory": "カテゴリ"
},
{
"DetailNameDetail": "明細名2",
"DetailPriceDetail": "2000",
"DetailQuantityDetail": "1",
"TransactionSn": "2",
"DetailBrand": "ブランド2",
"DetailCategory": "カテゴリ2"
}
]
}
結果パラメータ仕様
アトカラを選択した場合に返却される固有の結果パラメータは以下の通りです。
| パラメータ | 説明 | 形式 |
|---|---|---|
atokara | アトカラ固有部（親要素） アトカラ決済固有の結果パラメータセットです。 | 半角英数32桁 固定 |
atokara.Status | 取引状態 取引の状態を示す以下の値が設定されます。 UNPROCESSED：未決済（決済が完了していない状態）AUTH：仮売上SHIPPED：即時売上PAYFAIL：決済失敗（アトカラの与信審査がNGとなった状態） | — |
atokara.Processdate | 処理日時 決済依頼を実施した日時が設定されます。 （yyyyMMddHHmmss形式） | 半角数字14桁 |
atokara.AtokaraTransactionId | アトカラ取引ID アトカラにて取引個別に付加する取引のID | 半角英数字11桁 |
画面遷移
アトカラを選択した場合の画面遷移は以下の通りです。
- 決済選択/入力画面：決済手段としてアトカラを選択、必要な情報を入力
- 決済確認画面：入力内容を確認
- 決済事業者画面（アトカラ）：アトカラサイトにて決済手続き
- レシート画面：決済完了
ワンポイント
確認画面、レシート画面はスキップ可能です。
スキップする場合は、共通パラメータのConfirmSkipFlagおよびReceiptSkipFlagを設定してください。
画面構成
決済選択/入力画面
- 決済選択コンボボックスで「アトカラ」をクリック
デジタルコンテンツを扱っていない加盟店様は「郵便番号・住所」が必須入力となります。
デジタルコンテンツを扱う加盟店様は「郵便番号・住所」が非表示となります。
- 必要な情報を入力し「次へ」をクリック
決済確認画面
決済入力画面でお客様が入力した内容が表示されます。
決済事業者画面（アトカラ）
お客様はアトカラサイトにて決済手続きを行います。
レシート画面
アトカラサイトにて決済手続きが完了した際に表示されます。
