CSV課金
CSVファイルをアップロードすることで、既存の顧客に再び課金することができる機能です。
顧客の支払い情報が予めリカーリングトークンとして登録されている必要があります。
CSVファイルで提供された情報を元に、指定された顧客データの中で最も新しく登録されたリカーリングトークンを識別します。
その後、リカーリングトークンに保存された支払い情報を再利用して、新たな課金を行います。
対応している決済方法は、クレジットカード / Paidyのみです。
銀行振込 / コンビニ決済は対応していません。
※ご利用にはオプション契約が必要です。
ファイルのフォーマット
CSVファイルのコンテンツ
※アップロード、結果ダウンロード時の文字コードはUTF-8です。
CSVファイル作成には、4つの項目が必要です:
項目 | 説明 |
---|---|
ジョブID | どの種類のデータを探せばよいかをシステムに知らせます |
顧客データ | 顧客と関連するリカーリングトークンを識別するために使用されるデータです |
金額 | 新しい課金金額を入力する欄です。例:1000 |
通貨 | 新しい課金通貨を選択する欄です。例:円ならJPY、米ドルならUSD |
CSV課金アップロード時にメタデータを付与する
メタデータを付与するためには、「通貨」の右の列にフィールドを指定する必要があります。
基本のパターンは「:」で区切ったキーと値です。key-one:value one
複数追加したい場合は「|」で区切ります。key-one:value one|key-two:value two
値に「,」を利用する場合は下記のように指定してください。key-one:"value one,123"
各ジョブIDについて
①顧客ID(ジョブID = 1)
顧客IDはメタデータであり、リカーリングトークン登録処理時に任意で付与することができます。
システムでは、この顧客IDでタグ付けされたリカーリングトークンを検索し、新しい課金を行います。
例:1,c5d1b760-c7db-4696-a943-8ce90c988486(顧客ID),1000,JPY
②顧客のメールアドレス(ジョブID = 2)
このオプションを使用するには、1列目にジョブIDとして2
を、2列目に顧客のメールアドレスを入力してください。
システムでは、このメールアドレスがタグ付けされた最新のリカーリングトークンを検索し、新しい課金を行います。
例:
2,test@univapay.com(メールアドレス),1000,JPY
③リファレンスID(ジョブID = 3)
リファレンスIDはメタデータであり、リカーリングトークン登録処理時に任意で付与することができます。
システムでは、このリファレンスIDがタグ付けされた最新のリカーリングトークンを検索し、新しい課金を行います。
例:
3,AB0001(リファレンスID),1000,JPY
④リカーリングトークンID(ジョブID = 4)
リカーリングトークン作成時に当システムで自動的に発番されるIDを用います。
システムでは、このIDを持つリカーリングトークンを検索し、新しい課金を行います。
例:
4,11ecc509-cc27-28fe-9283-033858e9ed30(リカーリングトークンID),1000,JPY
サンプルファイル
※異なるジョブの指定を同じ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,metadata,SUCCESSFUL,1000,JPY,11ed1a13-525e-1bea-b97b-a