課金 – CREATE
課金オブジェクトに対するCREATEリクエストには以下が必要です。（括弧内は入力箇所）
- シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request POST \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'Content-type: application/json' \利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド名 赤字は必須 ※は条件付き必須 | データ型 | 備考 |
|---|---|---|
| transaction_token_id | string (UUID) | トランザクショントークンのID |
| amount | number | 課金額 |
| currency | string (ISO-4217) | 通貨 |
| capture | boolean | 支払いをキャプチャするかどうかfalse：課金承認のみデフォルトの値： true |
| capture_at | string (ISO-8601) | 記入されたトランザクショントークンのpayment_typeが・ payment_type=card- captureがfalseの場合、最初に課金を承認し、指定された日時に請求をキャプチャ・ payment_type=konbiniかbank_transfer- 支払期限の日時を設定できます。 トランザクションの支払い期間よりこちらを優先します。 ※「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が利用できないため、時刻は無視されその日までという扱いになります。 |
| merchant_transaction_id | string | 支払先の取引ID 取引IDは一意である必要があり、決済ブランドが指定する条件を満たす必要あり 以下の支払先で利用可能 – we_chat (最大32 英数字)– we_chat_mpm (最大32 英数字)– we_chat_online (最大32 英数字) |
| metadata | object | メタデータを参照 |
| redirect.endpoint | string (URL) | 支払い完了後にリダイレクトするURL 顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされる univapayChargeIdとunivapayTokenIdに加えて、課金作成時に指定されたメタデータ（作成後に変更された追加メタデータは含まれない）がクエリパラメータの一部として自動的に送信される また、クエリパラメータをURL末尾に追加することも可能 ※以下の支払いブランドでのみ利用可能 alipay_online,alipay_plus_online,pay_pay_online |
Bodyの記述例
curl --request POST \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'Content-type: application/json' \
--data '{
"transaction_token_id": "11ef32a7-3a71-8662-803f-1bc27702eeec",
"amount": 1000,
"currency": "JPY",
"metadata": {
"order_id": 12345,
"shipping_details": "Customer wants it now"
},
"redirect": {
"endpoint": "https://test.url/"
}
}'
レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
201 - Header:
Content-Type: application/json
Body
{
"id": "11ef32c2-4010-a312-aaff-4b63e4d5f92d",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"transaction_token_id": "11ef32a7-3a71-8662-803f-1bc27702eeec",
"transaction_token_type": "recurring",
"subscription_id": null,
"merchant_transaction_id": null,
"requested_amount": 1000,
"requested_currency": "JPY",
"requested_amount_formatted": 1000,
"charged_amount": null,
"charged_currency": null,
"charged_amount_formatted": null,
"fee_amount": null,
"fee_currency": null,
"fee_amount_formatted": null,
"only_direct_currency": false,
"capture_at": null,
"descriptor": null,
"descriptor_phone_number": null,
"status": "pending",
"error": null,
"metadata": {
"order_id": 12345,
"shipping_details": "Customer wants it now"
},
"mode": "test",
"created_on": "2024-06-25T07:12:15.16452Z",
"redirect": {
"endpoint": "https://test.url/",
"redirect_id": "11ef32c2-40cf-f772-8325-1798abb1110d"
}
}