v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB

Token Management

Get Token Details

Get the details associated with a OnlinePay issued reuse token.

get/api/v2/card/{id}

Path parameters

{"stackTrail":"paths:/api/v2/card/{id}:get:parameters:0:schema","oasType":"schema","type":"unknown","title":"Verifone Reuse Token"}

The OnlinePay issued reuse token used to represent the previously stored cardholder data.

Response

Token Result.

reuse_tokenstring

The identifier used to represent the Cardholder data.

analytics_tokenstring

A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes.

binstring

The Bank Identification Number (also called IIN - Issuer Identification Number) of this card.

expiry_monthinteger

A 2 digit value as shown on card. ISO8583 - DE 14

expiry_yearinteger

A 4 digit value as shown on card.

last_fourstring

The last 4 digits of the card number.

card_holder_namestring

The Card holder name as it appears on the card.

brandstring

The brand of this card. eg. VISA, MASTERCARD, AMEX.

issuer_country'ZZZ' | 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BSB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MOZ' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGC' | 'SGP' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE'

The ISO 3166-1 alpha-3 country code.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as is used in that country's top-level domain names.</blockquote>.

issuer_namestring

The issuer of this card. eg. HSBC, BARCLAYS.

currency'AUD'

Three-letter ISO 4217 alphabetical currency code. Supported values are: AUD

type'DEBIT' | 'CREDIT'

The type of card application or account selection.

variantstring

The variant of the card. eg. NEW_WORLD

updated_atstring date

The last date token was updated.

created_atstring date

The last date token was created.

token_expiry_datestring date

When this Token will expire.

reuse_token_type'INTERNAL'

The type of Reuse Token. This indicates if the reuse token is an internal OnlinePay type or an external Third-Party type.

token_scopestring uuid

The token scope under which this token was created.

token_status'DELETED' | 'ACTIVE' | 'SUSPENDED'

The status of the Token.

Example response

{
  "bin": "492912",
  "expiry_month": 12,
  "expiry_year": 2021,
  "last_four": "3127",
  "card_holder_name": "MR J HOLDER",
  "brand": "VISA",
  "issuer_name": "HSBC",
  "type": "CREDIT",
  "variant": "NEW_WORLD",
  "token_status": "ACTIVE",
  "bin_details": {
    "bin": "492912",
    "brand": "VISA",
    "issuer_name": "HSBC",
    "last_four": "3127",
    "type": "CREDIT",
    "variant": "NEW_WORLD"
  }
}