課金 – 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 英数字)
client_metadata.ip_address	string	消費者のデバイスのIPv4アドレス
metadata	object	メタデータを参照
redirect.endpoint	string (URL)	支払い完了後にリダイレクトするURL 顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされる univapayChargeIdとunivapayTokenIdに加えて、課金作成時に指定されたメタデータ（作成後に変更された追加メタデータは含まれない）がクエリパラメータの一部として自動的に送信されるまた、クエリパラメータをURL末尾に追加することも可能 ※以下の支払いブランドでのみ利用可能 `alipay_online`,`alipay_plus_online`,`pay_pay_online`
three_ds.redirect_endpoint	string (URL)	3DS認証後に顧客をリダイレクトするURL 顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされます。 `univapayChargeId`と`univapayTokenId`に加えて、すべてのメタデータ（課金作成時に指定されたもの、作成後に更新されたメタデータは含まない）が自動的にクエリパラメータの一部として送信されます。任意でエンドポイントURLに追加のクエリパラメータを追加することができます。
three_ds.mode	string	課金の3D-セキュア認証の種類 `normal`、`require`、`force`、`skip`のいずれかデフォルトでは`normal`が指定されます。トランザクショントークン作成時に3-Dセキュア認証が完了している場合、3-Dセキュア認証はスキップされ、そうでない場合は3-Dセキュア認証が必要となります。 `require`を指定するとトランザクショントークンですでに3-Dセキュア認証が完了していても、3D-セキュア認証を要求します。この時、3-Dセキュアのリスクベース認証によっては本人認証が要求されず決済が完了になる可能性があります。 `force`を指定するとトランザクショントークンですでに3-Dセキュア認証が完了していても、強制的に3-Dセキュア認証を行います。この時チャレンジ認証が強制的に行われ、本人認証が必要になります。 `skip`を指定すると3-Dセキュア認証をスキップします。これは、消費者が3-Dセキュアを実行できない特定のケースでのみ使用します。使用するにはアプリトークンのシークレットが必要です。

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"
    }
}

課金 – CREATE

リクエスト

CommandとHeader

利用できるパラメータ

Bodyの記述例

レスポンス

CodeとHeader

Body

課金 – CREATE

CONTENTS