Transaction Token: List

Request

GET https://api.univapay.com/stores/{storeId}/tokens
List tokens for all stores
GET https://api.univapay.com/tokens

Parameters:

Parameters
fromstring (ISO-8601)
Filter for transaction tokens created after this date.
tostring (ISO-8601)
Filter for transaction tokens created before this date.
idstring (UUID)
The transaction token ID
short_idstring
The last 6 characters of the transaction token ID
typestring
Filter by token type: recurring or subscription.
emailstring
Filter by the email address registered on the transaction token
cardholderstring
Filter by the cardholder name registered on the transaction token.
Only applicable for card payment type
card_expnumber
Filter by the expiration of the credit card used, in the format of yyyy-MM. E.g. 2024-01.
Only applicable for card payment type
card_last_fournumber
Filter by the last 4 digits of the card used.
Only applicable for card payment type
phone_numbernumber
Filter using a phone number
brandstring
Filter by the brand of the payment method. E.g. visa, alipay_china, pay_pay_mpm, seven_eleven, we_chat_online, aozora_bank, etc.
customer_idstring (UUID)
Filter for the token registered to the customer id as registered in the metatdata key `univapay-customer-id`
modestring
Filter by processing mode. live or test.
metadatastring
Filter by metadata contents.

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api.univapay.com/stores/af857264-180c-11e7-9be2-276aea4fed28/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'
List charges for all stores
curl --request GET \
--url https://api.univapay.com/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "11eeb430-ac66-575c-af2d-bbca651dd414",
      "merchant_id": "11e746a0-d62d-7174-a46d-538bfebf4322",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "email": "token@univapay.com",
      "payment_type": "card",
      "active": true,
      "mode": "test",
      "type": "recurring",
      "metadata": {},
      "created_on": "2024-01-16T05:32:43.886685Z",
      "updated_on": "2024-01-16T05:32:43.886685Z",
      "last_used_on": null,
      "merchant_name": "サンプルショップ",
      "store_name": "test store",
      "user_data": {
        "cardholder_name": "test test",
        "brand": "visa",
        "gateway": null,
        "service_provider": null
      }
    },
    {
      "id": "11eeb42f-f08c-0e14-b72f-bf4af680988d",
      "merchant_id": "11e746a0-d62d-7174-a46d-538bfebf4322",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "email": "token@univapay.com",
      "payment_type": "card",
      "active": true,
      "mode": "test",
      "type": "subscription",
      "metadata": {},
      "created_on": "2024-01-16T05:27:28.723026Z",
      "updated_on": "2024-01-16T05:27:33.627696Z",
      "last_used_on": "2024-01-16T05:27:33.665821Z",
      "merchant_name": "サンプルショップ",
      "store_name": "test store",
      "user_data": {
        "cardholder_name": "takahiro nasu",
        "brand": "visa",
        "gateway": null,
        "service_provider": null
      }
    }
  ],
  "has_more": false
}