イシュアトークン – GET
イシュアトークンオブジェクト
イシュアトークンとは、オンライン決済事業者から提供された消費者が決済を行うための情報です。
各決済事業者での支払いURLなどが発行されます。
支払い手段がonlineのトランザクショントークンを使用して課金を作成した後にイシュアートークンを取得します。
支払手段が銀行振込（bank_transfer）の場合は、対象の振込先口座情報を取得します。issuer_tokenが入力される前に、課金ステータスがawaitingになっている必要があります。awaiting以外のステータスではこのリクエストはエラーになるため、課金:GETのリクエストで、事前に課金ステータスの確認を行う必要があります。
課金オブジェクトに対するイシュアトークンのGETリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - 課金ID（URLの
{chargeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/charges/{chargeId}/issuer_token \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \イシュアトークンオブジェクトのデータ構造
レスポンスで返却されるイシュアトークンオブジェクトのデータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| payment_type | string | 指定した課金の支払い手段の種類online, bank_transferのいずれか |
| issuer_token | string | payment_typeがonlineのときクライアントが実行するために支払いプロバイダーから提供されたトークン 本番モードの場合各決済事業者での支払いURLが発行されます |
| payload | object | payment_typeがonlineのときPOSTリクエストを送信するために必要なデータを含むオブジェクトを返却 |
| call_method | string | payment_typeがonlineのときクライアントによる実行方法 http_get, http_post, sdk, web, appのいずれか各ブランドで対応している方法で実行してください（詳細はこちら） – sdkは、ペイメントプロバイダーが提供するSDKで直接使用することを意味する– webとは、特定のAPIを拡張した特殊なブラウザ環境で直接使用を意味する– appとは、ペイメントプロバイダーが提供するSDKのネイティブアプリ環境での利用を意味する– http_getまたはhttp_postを使用すると、issuer_tokenを新しいブラウザウィンドウまたは適切対応するHTTPメソッドのiframe内で直接実行することが可能※Wechat利用時の注意点 ・call_method が http_getの場合、リクエスト前に利用予定のウェブブラウザのドメインをサポートデスクへ連絡する必要あり・サポートデスクへ連絡したドメインからリダイレクトしてイシュアトークンを取得する必要あり |
| account_id | string | payment_typeがbank_transferのとき接続先システムで発行している口座の独自ID |
| branch_code | string | payment_typeがbank_transferのとき支店コード |
| branch_name | string | payment_typeがbank_transferのとき支店名 |
| account_holder_name | string | payment_typeがbank_transferのとき口座名義 |
| account_number | string | payment_typeがbank_transferのとき口座番号 |
記述例
curl --request GET \
--url https://api.univapay.com/stores/11ecda54-17a0-1c78-bd5c-73aa272l700f/charges/11ef3398-8a6c-978e-8332-2f61a5ed40t4/issuerToken \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \レスポンス
下記は記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body (online)
{
"issuer_token": "http://test.com/action",
"call_method": "http_post",
"payload": {
"test_parameter": "test_value"
}
"payment_type": "online"
}Body (bank transfer)
{
"account_id": "test account id",
"branch_code": "123",
"branch_name": "test branch name",
"account_holder_name": "test holder name",
"account_number": "1234567",
"payment_type": "bank_transfer"
}d払いOnlineについて
d払いOnlineを利用する場合、取得したイシュアトークンのURLに対して、レスポンスのpayloadにあるbodyの要素を含み、POST方式で実行する必要があります。
Headerの Content-Typeは application/x-www-form-urlencoded のみ受け付ける仕様です。
イシュアトークン取得のレスポンス例
{
"issuer_token": "https://payment1.smt.docomo.ne.jp/smph/trade/s/gabepa11.srv",
"call_method": "http_post",
"payload": {
"sSpcd": "00000000000",
"sCptok": "11eefaef-e2d6-5e3c-3cj3-7f0a72dd9ba7%2Clive%2C9f132db784f807abe60a566634a9791fc979d9b0ed330d6314a6cfb29af39cae",
"sTerkn": "01"
},
"payment_type": "online"
}
call_methodがhttp_postの場合の実行方法
レスポンスのデータを基にPOSTリクエストを送信する場合は、下記のようなHTMLフォームを設置することで実行できます。
<FORM METHOD="POST" ACTION="http://test.com/action">
<INPUT TYPE="HIDDEN" NAME="test_parameter" VALUE="test_value">
</FORM>