課金: Create

このリクエストでは、アプリトークン・シークレット・事前に作成されたトランザクションIDを指定することで、顧客の個人情報・決済に関する情報を呼び出して課金を作成することができます。
このルートではアプリケーショントークンのシークレットは必須です

Request

POST https://api.univapay.com/charges

Parameters:

Parameters
transaction_token_idstring (UUID) [必須]
トランザクショントークンのID
amountnumber [必須]
課金額
currencystring (ISO-4217) [必須]
ISO-4217形式の通貨
only_direct_currencyboolean
trueの場合、 システムは指定された通貨でのみ課金をを試み、利用可能な適切なプロバイダーがない場合に失敗します。
デフォルトはfalse
captureboolean
支払いをキャプチャするかどうか。 falseの場合、課金は承認されるだけです。
デフォルトはtrue
capture_atstring (ISO-8601)
記入されたトランザクショントークンのpayment_type
payment_type=card
 - capturefalseの場合、最初に課金を承認し、指定された日時に請求をキャプチャします。
payment_type=konbinibank_transfer
 - 支払期限の日時を設定できます。
  トランザクションの支払い期間よりこちらを優先します。
※「セブンイレブン」「セイコーマート/他支払(サークルK/サンクス/ペイジー)」は時刻指定が利用できないため、時刻は無視されその日までという扱いになります。
merchant_transaction_idstring
支払先の取引IDを設定する項目です。取引IDは一意である必要があり、決済ブランドが指定する条件を満たす必要があります。
以下の支払先で有効です。
we_chat (最大32 英数字)
we_chat_mpm (最大32 英数字)
we_chat_online (最大32 英数字)
metadataobject
メタデータを参照
redirect.endpointstring (URL)
支払い完了後にリダイレクトするURL。
顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされます。
univapayChargeIdとunivapayTokenIdに加えて、課金作成時に指定されたメタデータ(作成後に変更された追加メタデータは含まれません)がクエリパラメータの一部として自動的に送信されます。
また、クエリパラメータをURL末尾に追加することもできます。

以下の支払いブランドでのみサポートされています:
– alipay_online
– alipay_plus_online
– pay_pay_online

Headers:

Content-Type: application/json
Authorization: Bearer {secret}.{jwt}

Body:

curl --request POST \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'Content-type: application/json' \
--data '{
"transaction_token_id": "9c3b37f8-1851-11e7-9b58-8b8ddbe8f1d1",
"amount": 1000,
"currency": "JPY",
"metadata": {
    "order_id": 12345,
    "shipping_details": "Customer wants it now"
  },
"redirect": {
    "endpoint": "https://test.url/path?additionalParams=paramValue"
  }
}'

Response

Code: 201

Headers:

Content-Type: application/json

Body:

{
  "id": "a29db148-1851-11e7-9b58-4b8e9d783793",
  "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
  "transaction_token_id": "9c3b37f8-1851-11e7-9b58-8b8ddbe8f1d1",
  "requested_amount": 1000,
  "requested_currency": "JPY",
  "requested_amount_formatted": 1000,
  "charged_amount": null,
  "charged_currency": null,
  "charged_amount_formatted": null,
  "status": "pending",
  "error": null,
  "metadata": {
    "shipping_details": "Customer wants it now",
    "order_id": 12345
  },
  "mode": "test",
  "redirect": {
    "redirect_id": "f1e62f0c-e032-4438-8d0a-34931e942e4e",
    "endpoint": "https://test.url/path?additionalParams=paramValue"
  }
  "created_on": "2018-07-13T02:55:00.07367Z"
}