Tokens

Tokenization hides sensitive payment information into a unique token for a secure transaction. The token does not expose any actual payment details.

Tokens attributes

required, string, max chars=40

Identifier of the Chargebee Token

gateway

required, enumerated string

Name of the gateway this token is stored in.

Enum Values

chargebee

Chargebee test gateway.

chargebee_payments

Chargebee Payments gateway

adyen

Adyen is a payment gateway.

stripe

Stripe is a payment gateway.

wepay

WePay is a payment gateway.

gateway_account_id

required, string, max chars=50

The gateway account in which this token is stored.

payment_method_type

required, enumerated string

Type of payment method of the token.

Enum Values

card

Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.

paypal_express_checkout

Payments made via PayPal Express Checkout.

amazon_payments

Payments made via Amazon Payments.

direct_debit

Represents bank account for which the direct debit or ACH agreement/mandate is created.

generic

Payments made via Generic Payment Method.

status

required, enumerated string, default=new

Status of the token

Enum Values

new

expired

consumed

The token is already used

id_at_vault

required, string, max chars=65k

The id with which this token is referred in gateway

vault

required, enumerated string

Name of the gateway/vault provider where the payment method is tokenized

Enum Values

spreedly

gateway

ip_address

optional, string, max chars=50

The IP address from where the token is created. Used primarily for EU VAT validation.

resource_version

optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_at

optional, timestamp(UTC) in seconds

Timestamp indicating when this token resource was last updated.

created_at

required, timestamp(UTC) in seconds

Timestamp indicating when this token resource is created.

expired_at

optional, timestamp(UTC) in seconds

Timestamp indicating when this token is expired