v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB

Token Management

Update Token Details

Update the details associated with a OnlinePay issued reuse token.

If the token needs to be linked to a new PAN, the card property must be present.

It is possible to update only partial details against the same card on file like expiry date, cardholder name or CVV.

patch/api/v2/card/{id}

Path parameters

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

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

Request body

encrypted_cardstring

The cardholder data encrypted using the OnlinePay provided public key. This can be obtained using either Verifone.JS solution or OnlinePay Checkout in capture mode.

The data to encrypt is a JSON with possible tags being cardNumber, sequenceNumber, cardholderName, startMonth, startYear, expiryMonth, expiryYear, cvv. This should be a single JSON line and should not contain any spaces. Read <a target="_blank" style="color:blue;" href="https://verifone.cloud/docs/online-payments/secure-card-capture-key">Secure card capture key</a> for details.

Additionally, a tag called captureTime must be presenting indicating the time the card was captured in UTC in format RFC 3339, section 5.6. eg. 2019-08-24T14:15:22Z. Encrypted card is valid for only 15 minutes.

cvvstring

The CVV (Card Verification Value) as it appears on the card.

card_holder_namestring

The Card holder name as it appears on the card.

card_holder_emailstring email

A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1.

expiry_monthinteger

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

expiry_yearinteger

Card expiry year. A 4 digit value as shown on the card.

token_expiry_datestring date

When this Token will expire.

public_key_aliasstring

scheme_token_action'ACTIVATE' | 'SUSPEND' | 'DELETE'

Indicates if the scheme tokens should be created / deleted / suspended. Scheme tokens will be created only if token scope has PAR and/or network token support configured.

Example request

{
  "encrypted_card": "U3dhZ2dlciByb2Nrcw==",
  "cvv": "MR J HOLDER",
  "card_holder_name": "MR J HOLDER",
  "expiry_month": 12,
  "expiry_year": 2021
}

Response

Token result

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.

card_holder_emailstring email

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.

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

The status of the Token.

currency'AUD'

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

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>.

Example response

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