API Reference

Payment Token object

This is an object representing your payment tokens.

Payment tokens

Payment tokens are pre-authorized payment methods you can use to make future payments without entering details of the payment method or going through the authorization process again with your issuer or bank.

You can retrieve all saved payment tokens of yours and you can also deactivate any of the active ones.


Payment token object fields

FieldData typeDescriptionType
idstringunique id of payment tokenrequired
token_typestringtype of payment method (card, direct_debit, ach_debit)required
countrystringtwo-letter ISO code representing the country of the payment methodrequired
bank_codestringbank code of issuing bank or financial institutionoptional
branch_codestringbank branch code of issuing bank or financial institutionoptional
fingerprintstringtokenized unique identifier of payment methodoptional
brandstringbrand of payment methodoptional
last_4stringlast 4 digits of payment methodoptional
exp_monthintegerexpiry month of payment methodoptional
exp_yearintegerexpiry year of payment methodoptional
reusablebooleanspecifies if the payment token can be used againrequired
billing_address_line1stringfirst line of customer address associated with the payment methodoptional
billing_address_line2stringsecond line of customer address associated with payment methodoptional
billing_address_citystringcity of customer address associated with payment methodoptional
billing_address_statestringstate of customer address associated with payment methodoptional
billing_address_countrystringcountry of customer address associated with payment methodoptional
billing_address_zipstringzip code of customer address associated with payment methodoptional
event_logjsonlog of important event timestamps of the payment tokenoptional
metadatajsonmetadata to store extra informationoptional