トランザクショントークン – UPDATE
トランザクショントークンオブジェクトに対するUPDATEリクエストには以下が必要です。(括弧内は入力箇所)
- 店舗ID(URLの
{storeId}
部分) - トランザクショントークンID(URLの
{id}
部分) - シークレット(Headreの
{secret}
部分) - アプリトークン(Headerの
{jwt}
部分)
リクエスト
CommandとHeader
curl --request PATCH \
--url https://api.univapay.com/stores/{storeId}/tokens/{id} \
--header 'Content-type: application/json'
--header 'Authorization: Bearer {secret}.{jwt}'
利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
フィールド | データ型 | 備考 |
---|---|---|
string | 支払いの為の顧客のメールアドレス | |
cardholder | string | カード名義 |
metadata | object | トランザクショントークンに保存されているメタデータ |
data.cvv | number | カードのCVV リカーリングトークンを使用して課金を作成する際に RECURRING_USAGE_REQUIRES_CVV エラーがした場合に必要CVVだけを更新する場合はアプリケーショントークンのシークレットは不要 |
data.line1 | string | 住所1 |
data.line2 | string | 住所2 |
data.state | string | 住所の州/地域/都道府県 |
data.city | string | 住所の市町村区 |
data.country | string | 国 (ISO 3166-1形式のアルファベット2文字の国コード) |
data.zip | string | 郵便番号 |
data.phone_number.country_code | string | 電話番号の国コード |
data.phone_number.local_number | string | 電話番号 |
Bodyの記述例
curl --request PATCH \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/tokens/11efa58e-e0b7-9a02-9ca6-7788908dad3a \
--header 'Authorization: Bearer {secret}.{jwt}'
--data '{
"email": "test.update@test.com",
"data": {
"cardholder": "TARO YAMADA",
"card_number": "4000020000000000",
"exp_month": "12",
"exp_year": "2099",
"cvv": "123",
"line1": "11111",
"line2": "222",
"state": "Tokyo",
"city": "テスト区一丁目",
"country": "JP",
"zip": "1234567",
"phone_number": {
"country_code": "81",
"local_number": "08000000000"
}
}
}'
レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200
- Header:
Content-Type: application/json
Body
{
"id": "11efa58e-e0b7-9a02-9ca6-7788908dad3a",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"email": "test.update@test.com",
"payment_type": "card",
"active": true,
"mode": "test",
"type": "recurring",
"usage_limit": null,
"confirmed": null,
"metadata": { },
"created_on": "2024-11-18T09:24:14.584144Z",
"updated_on": "2024-11-19T05:53:48.547425Z",
"last_used_on": "2024-11-18T09:24:14.795465Z",
"data": {
"card": {
"cardholder": "TARO YAMADA",
"exp_month": 12,
"exp_year": 2099,
"card_bin": "400002",
"last_four": "0000",
"brand": "visa",
"card_type": "credit",
"country": "US",
"category": null,
"issuer": "RIVER VALLEY CREDIT UNION",
"sub_brand": "none"
},
"billing": {
"line1": "11111",
"line2": "222",
"state": "Tokyo",
"city": "テスト区一丁目",
"country": "JP",
"zip": "1234567",
"phone_number": {
"country_code": 81,
"local_number": "08000000000"
}
},
"cvv_authorize": {
"enabled": false,
"status": null,
"charge_id": null,
"credentials_id": null,
"currency": "JPY"
},
"cvv_authorize_check": {
"status": null,
"charge_id": null,
"date": null
},
"three_ds": {
"enabled": false,
"status": null,
"redirect_endpoint": null,
"redirect_id": null
}
}
}