ガイド
SmartpayサイトへEnglish

トークンを管理する

このガイドでは、利用可能なトークンを検索する方法、無効化、再有効化、および削除する方法を説明します。

トークンの作成後は、Smartpay API を使ってトークンを取得、無効化、再有効化、および削除できます。

トークンの取得

Smartpay API を使って、すべてのトークンのリストや特定のトークンを取得することができます。

Smartpay は有効なトークンと無効化されたトークンのみを返します。削除されたトークンは返されません。

すべてのトークンのリスト表示

すべてのトークンをリスト表示するには、すべてのトークンのリスト表示 エンドポイントにリクエストを送信します。

curl --request GET \
     --url 'https://api.smartpay.co/v1/tokens?maxResults=20' \
     --header 'Authorization: Basic sk_test_abcdef12345678' \
     --header 'accept: application/json'

特定のトークンの取得

特定のトークンを取得するには、トークンの取得 エンドポイントにリクエストを送信します。

curl --request GET \
     --url 'https://api.smartpay.co/v1/tokens/paytok_test_zAo001ZRfyjz1F4rMyYPnL' \
     --header 'Authorization: Basic sk_test_abcdef12345678' \
     --header 'accept: application/json'

トークンの無効化

トークンの無効化

トークンの無効化 API エンドポイントを呼び出すと、トークンを一時的に無効化することができます。この操作を行うと、トークンのステータスが disabled になり、そのトークンを使った注文の作成ができなくなります。この操作は、トークンを有効化すると元に戻せます。

curl --request PUT \
     --url 'https://api.smartpay.co/v1/tokens/paytok_test_zAo001ZRfyjz1F4rMyYPnL/disable \
     --header 'Authorization: Basic sk_test_abcdef12345678' \
     --header 'accept: application/json'

トークンの削除

トークンを永遠に無効化する場合は、トークンの削除 API エンドポイントを呼び出します。トークンを削除すると、そのトークンを使った注文の作成ができなくなります。

これは元に戻すことができない操作であり、削除したトークンを Smartpay が再び有効化することはできません。

curl --request DELETE \
     --url 'https://api.smartpay.co/v1/tokens/paytok_test_zAo001ZRfyjz1F4rMyYPnL \
     --header 'Authorization: Basic sk_test_abcdef12345678' \
     --header 'accept: application/json'

トークンの有効化

無効化されたトークンを有効化するには、トークンの有効化 API エンドポイントを呼び出します。トークンを有効化すると、再びそのトークンを使ってお客様への請求ができるようになります。

curl --request PUT \
     --url 'https://api.smartpay.co/v1/tokens/paytok_test_zAo001ZRfyjz1F4rMyYPnL/enable \
     --header 'Authorization: Basic sk_test_abcdef12345678' \
     --header 'accept: application/json'

Updated 6 months ago