イシュアトークン
イシュアトークンオブジェクト
イシュアトークンとは、オンライン決済事業者から提供された、ユーザーが決済を行うための情報です。各決済事業者での支払いURLなどが発行されます。
このルートは、支払い手段がonline
のトランザクショントークンを使用して課金を作成した後に、イシュアートークンを取得するために使用します。
支払手段が銀行振込(bank_transfer
)の場合は、対象の振込先口座情報を取得することができます。issuer_token
が入力される前に、課金ステータスがawaiting
になっている必要があります。awaiting
以外のステータスではこのリクエストはエラーになるため、課金:GETのリクエストで、事前に課金ステータスの確認を行う必要があります。
Fields | |
payment_type | string 指定した課金の支払い手段の種類。 online , bank_transfer のいずれか |
issuer_token | stringpayment_type がonline のときクライアントが実行するために支払いプロバイダーから提供されたトークン。 本番モードの場合各決済事業者での支払いURLが発行されます |
payload | objectpayment_type がonline のときPOSTリクエストを送信するために必要なデータを含むオブジェクトを返却します。 |
call_method | stringpayment_type がonline のときクライアントによる実行方法です。 http_get , http_post , sdk , web , app のいずれかです。各ブランドで対応している方法で実行してください。(詳細はこちら) – sdk は、ペイメントプロバイダーが提供するSDKで直接使用することを意味します。– web とは、特定のAPIを拡張した特殊なブラウザ環境で直接使用することを指します。– app とは、ペイメントプロバイダーが提供するSDKのネイティブアプリ環境での利用を指します。– http_get またはhttp_post を使用すると、issuer_token を新しいブラウザウィンドウまたは適切な対応するHTTPメソッドのiframe内で直接実行することができます。 |
account_id | stringpayment_type がbank_transfer のとき接続先システムで発行している口座の独自ID |
branch_code | stringpayment_type がbank_transfer のとき支店コード |
branch_name | stringpayment_type がbank_transfer のとき支店名 |
account_holder_name | stringpayment_type がbank_transfer のとき口座名義 |
account_number | stringpayment_type がbank_transfer のとき口座番号 |
Request
GET https://api.univapay.com/stores/{storeId}/charges/{chargeId}/issuer_token
Headers:
Content-Type: application/json
Authorization: Bearer {secret}.{jwt}
Response
Code: 200
Headers:
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>