CSV課金

CSVファイルをアップロードすることで、既存の顧客に再び課金することができる機能です。顧客のカード情報が予めシステムに登録され、リカーリングトークンに結びつけられている必要があります。

CSVファイルで提供された情報を元に、最新のリカーリングトークンを識別します。その後、リカーリングトークンに保存されたカード情報を再利用して、新たな課金を行います。

ファイルのアップロード

「CSV課金」ページから、「ファイルをアップロードする」ボタンをクリックします。

表示された画面から課金を実施する店舗を選択し、CSVファイルをアップロードします。
課金を行うためには、CSVファイルの顧客データ(リカーリングトークン)が選択した店舗と紐づいている必要があります。

CSVファイルのアップロード後、フォーマットにエラーがなければ自動的に課金処理が行われます。
先にファイルをアップロードし、任意のタイミングで手動実行したい場合は、「自動実行」をオフにすることができます。

CSVファイルのアップロードとチェックが完了し課金が処理されると、通知メールが送信されます。デフォルトの設定では、加盟店設定で登録された(管理画面のログイン)メールアドレスに送信されますが、別のメールアドレスへ送信したい場合は、「結果通知メールアドレス」の欄に入力し、指定することができます。

ステータス

  • アップロード中:CSVファイルがアップロードされ、チェックされています。
    このステップでは、フォーマットのエラーのみをチェックします。提供されたデータで課金が可能かどうかはチェックしません。
  • 登録済: ファイルのアップロードとチェックが正常に行われた状態です。
  • 登録失敗: フォーマットエラーが見つかり、ファイルの処理ができていない状態です。
  • 実行中: 課金が処理されています。
  • 実行済: すべての課金が処理された状態です。詳細なレポートを確認したい場合は、管理画面の「CSV課金」ページを参照してください。

ファイルのフォーマット

CSVファイルのコンテンツ

CSVファイル作成には、4つの項目が必要です:

  • ジョブID: どの種類のデータを探せばよいかをシステムに知らせます。
  • 顧客データ:顧客と関連するリカーリングトークンを識別するために使用されるデータです。
  • 金額: 新しい課金金額を入力する欄です。例:1000
  • 通貨: 新しい課金通貨を選択する欄です。例:円ならJPY、米ドルならUSD

CSV課金アップロード時にメタデータ付与の方法

パターンは「key:value」です。
key-one:value one

複数追加したいの場合は「|」で区切ります。
key-one:value one|key-two:two value

値に「,」を利用する場合
key-one:”value one,123″

以下の4つの例を参考に、さまざまな種類の顧客データを使用することができます。

顧客ID(customer-id)を使用する場合(ジョブID = 1)

顧客ID(customer-id)はメタデータであり、チェックアウトの際にリカーリングトークンとしてオプションで登録することができます。詳細は「ウィジェット:Javascript」ページ(univapayCustomerId)または「ウィジェット : HTML」ページ(data-univapay-customer-id)をご確認ください。

このオプションを利用するには、1列目にジョブIDとして1を、2列目に顧客ID(UUID形式)を入力します。

システムでは、この顧客IDでタグ付けされたリカーリングトークンを検索し、新しい課金を行います。

■サンプルデータ: 1,c5d1b760-c7db-4696-a943-8ce90c988486,1000,JPY

顧客のEメールを使用する場合(ジョブID = 2)

このオプションを使用するには、1列目にジョブIDとして2を、2列目に顧客のEメールアドレスを入力してください。

システムでは、このEメールアドレスを使って行われた最新の決済を検索し、新しい課金を行うためにどのリカーリングトークンを使用するのかを特定します。

■サンプルデータ: 2,test@.,1000,JPY

リファレンスIDを使用する場合(ジョブID = 3)

リファレンスIDはメタデータであり、リカーリングトークンを作成する際にAPI (univapay-reference-id) または「ウィジェット : HTML」ページ(data-univapay-reference-id) で設定することが可能です。

このオプションを使用するには、1列目にジョブIDとして3を、2列目にリファレンスID(フリーフォーマット)を入力します。

システムでは、このリファレンスIDがタグ付けされた最新の決済を検索し、どのリカーリングトークンを使って新しい課金を行うのかを特定します。

■サンプルデータ: 3,AB0001,1000,JPY

リカーリングトークンIDを使用する場合(ジョブID = 4)

このオプションを使用するには、1行目にジョブIDとして4を、2行目にリカーリングトークンID(UUIDフォーマット)を入力してください。

システムでは、このIDを持つリカーリングトークンを探して、新しい課金を行います。

■サンプルデータ: 4,11ecc509-cc27-28fe-9283-033858e9ed30,1000,JPY

サンプルファイル

サンプルファイルのダウンロード: csvcharges-sample.csv

※異なるジョブの指定を同じCSVファイルにまとめることも可能です:

1,c5d1b760-c7db-4696-a943-8ce90c988486,3000,JPY
2,test001@test.com,2500,JPY
3,AB00001,1000,JPY
4,11ecc509-cc27-28fe-9283-033858e9ed30,500,JPY

決済結果のダウンロード

CSV課金完了後、管理画面から結果ファイルをダウンロード可能です。

ファイルの内容(ヘッダー)は下記となります。

検索コマンド,検索パラメータ,リクエスト金額,リクエスト通貨,メタデータ,課金ステータス,課金金額,課金通貨,課金ID,エラーメッセージ

3,AB00001,1000,JPY,metadate,SUCCESSFUL,1000,JPY,11ed1a13-525e-1bea-b97b-af755a6274c7