--- title: "Redeem points related to a card" method: POST path: "/api/v2/transactions/redemption" tags: ["Redemption Order"] --- # Redeem points related to a card `POST /api/v2/transactions/redemption` Redeem points that is related to a given card. Redemptions on this endpoint will not be seen as a financial operation, but an order request to update the points used. This operation is currently only supported for Amex Pay with Points. ## Headers - `x-vfi-api-idempotencykey` string ## Request body - union - EncryptedCardRedemptionRequestBody - `payment_provider_contract` string, uuid-flexible, required — The identifier of payment provider contract you want to process the transaction request with. - `card_brand` string — Represents a Card type or brand. It should correspond to a consistent name, the list of standard names is as follows: Value | Description ------|------------- AMEX|American Express CB|Carte Bancaires DINERS|Diners Club International DISCOVER|Diners Club Discover JCB|Japan Credit Bureau MAESTRO|Multi-national Debit (MasterCard) MASTERCARD|MasterCard VISA|Visa UPI|Union Pay International GIFT_CARD|Gift Card (Generic) PLCC|Private Label Credit Card **Other local schemes as applicable**. Enter a pre-defined name to represent the scheme or type. **Note**: 1. For gift cards, card brand is mandatory and the value should be GIFT_CARD. 2. This parameter is mandatory for dual branded cards. - `amount` integer, required — Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field. - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL' | 'BTC', required — Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). **Deprecated:** `BYR` (replaced by BYN), `FRF` (replaced by EUR), `LTL` (replaced by EUR), `LVL` (replaced by EUR), `MRO` (replaced by MRU), `STD` (replaced by STN), `USS` (no replacement), `VEF` (replaced by VES), `ZMK` (replaced by ZMV) and `BTC` (Bitcoin only supported as Crypto Amount). - `pay_with_points` PayWithPoint, required — Points usage and balance might be part of the transaction request. This object will hold flags and details that is related to points. Use-cases are:
  • Whether transaction should be paid using loyalty points/reward points or other type of point
  • Points redemption order request
  • Points balance request
    • - `enabled` boolean, required — Flag to indicate whether to use points or not. - `points_type` 'AMEX' — Type or name of the points program. - `points_transaction_reference` string — Unique transaction reference to the related card transaction. - `points_transaction_reference_type` string — Type of the transaction reference. * `AUTH_CODE` The authorisation response code received from issuer/acquirer (as used in the ISO8583 specification (DE 38)) - `points_to_redeem` string — An amount type represented in points for all fields like points balance, points redemption, etc. when a points program is applicable in a transaciton or a query. - `total_basket_amount` integer — The total basket amount decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217: | Code | Currency | Decimals | Fixed minor units | | ---- | ------------- | -------- | ----------------- | | ISK | Iceland Krona | 2 | 00 | - `merchant_reference` string — A reference specified by the merchant to identify the transaction. - `shopper_interaction` 'ECOMMERCE' | 'MAIL' | 'TELEPHONE' | 'PHONE' — Determines the sales channel the shopper gives their card details through: * `ECOMMERCE` Online transactions where the cardholder is present. * `MAIL` order transactions where the shopper is in contact with the merchant via email. * `TELEPHONE` order transactions where the shopper is in contact with the merchant via telephone. - `invoice_number` string — Optional. The invoice number to track this payment. - `encrypted_card` string, required — The cardholder data encrypted using the Verifone provided public key. This can be obtained using either Verifone.JS solution or Verifone Checkout in capture mode. The data to encrypt is a JSON with possible tags being cardNumber, sequenceNumber, cardholderName, startMonth, startYear, expiryMonth, expiryYear, cvv. 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 - `public_key_alias` string, required — The alias for the public key used to encrypt this card. card/cvv/svc access code. - `token_preference` TokenPreferenceDto - `token_scope` string, uuid, required — The token scope under which this token was created. - `reuse_token_type` 'CHASE' | 'INTERNAL' | 'TAVE' — The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type.
    **Note**: `reuse_token_details` is **mandatory** when `reuse_token_type` is set to `TAVE` or `CHASE`. - `token_type` 'REUSE' | 'ANALYTICS' | 'REUSE_AND_ANALYTICS' — Token type - `token_expiry_date` string, date — When this Token will expire. - ReuseTokenRedemptionRequestBody - `payment_provider_contract` string, uuid-flexible, required — The identifier of payment provider contract you want to process the transaction request with. - `card_brand` string — Represents a Card type or brand. It should correspond to a consistent name, the list of standard names is as follows: Value | Description ------|------------- AMEX|American Express CB|Carte Bancaires DINERS|Diners Club International DISCOVER|Diners Club Discover JCB|Japan Credit Bureau MAESTRO|Multi-national Debit (MasterCard) MASTERCARD|MasterCard VISA|Visa UPI|Union Pay International GIFT_CARD|Gift Card (Generic) PLCC|Private Label Credit Card **Other local schemes as applicable**. Enter a pre-defined name to represent the scheme or type. **Note**: 1. For gift cards, card brand is mandatory and the value should be GIFT_CARD. 2. This parameter is mandatory for dual branded cards. - `amount` integer, required — Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field. - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL' | 'BTC', required — Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). **Deprecated:** `BYR` (replaced by BYN), `FRF` (replaced by EUR), `LTL` (replaced by EUR), `LVL` (replaced by EUR), `MRO` (replaced by MRU), `STD` (replaced by STN), `USS` (no replacement), `VEF` (replaced by VES), `ZMK` (replaced by ZMV) and `BTC` (Bitcoin only supported as Crypto Amount). - `pay_with_points` PayWithPoint, required — Points usage and balance might be part of the transaction request. This object will hold flags and details that is related to points. Use-cases are:
  • Whether transaction should be paid using loyalty points/reward points or other type of point
  • Points redemption order request
  • Points balance request
    • - `enabled` boolean, required — Flag to indicate whether to use points or not. - `points_type` 'AMEX' — Type or name of the points program. - `points_transaction_reference` string — Unique transaction reference to the related card transaction. - `points_transaction_reference_type` string — Type of the transaction reference. * `AUTH_CODE` The authorisation response code received from issuer/acquirer (as used in the ISO8583 specification (DE 38)) - `points_to_redeem` string — An amount type represented in points for all fields like points balance, points redemption, etc. when a points program is applicable in a transaciton or a query. - `total_basket_amount` integer — The total basket amount decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217: | Code | Currency | Decimals | Fixed minor units | | ---- | ------------- | -------- | ----------------- | | ISK | Iceland Krona | 2 | 00 | - `merchant_reference` string — A reference specified by the merchant to identify the transaction. - `shopper_interaction` 'ECOMMERCE' | 'MAIL' | 'TELEPHONE' | 'PHONE' — Determines the sales channel the shopper gives their card details through: * `ECOMMERCE` Online transactions where the cardholder is present. * `MAIL` order transactions where the shopper is in contact with the merchant via email. * `TELEPHONE` order transactions where the shopper is in contact with the merchant via telephone. - `invoice_number` string — Optional. The invoice number to track this payment. - `reuse_token` string, required — The Verifone or Third-Party issued reuse token used to represent the previously stored cardholder data. Required here if not referenced by providing the stored credential signup reference `stored_credential.reference` in a subsequent charge request. - `reuse_token_type` 'INTERNAL' | 'CHASE' | 'TAVE' — The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type. **Note**: `reuse_token_details` is **mandatory** when `reuse_token_type` is set to `TAVE` or `CHASE`. - `reuse_token_details` TokenDetailsRequestBody — The details related to the token. For Third-Party Reuse tokens, these elements might be required as additional information together with the Reuse token itself.
    **Note**: `reuse_token_details` is **mandatory** when `reuse_token_type` is set to `TAVE` or `CHASE`. - `expiry_month` integer — A 2 digit value as shown on card. ISO8583 - DE 14.\n\nThis is included as an optional value to be used for some Third-Party reuse token types. - `expiry_year` integer — A 4 digit value as shown on card.\n\nThis is included as an optional value to be used for some Third-Party reuse token types. - `public_key_alias` string — The alias for the public key used to encrypt this card. card/cvv/svc access code. ## Response `201` Response for gift card transactions - PointsRedemptionResponse - `id` string, uuid-flexible — The ID of the transaction. - `amount` integer — Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field. - `balance_amount` integer — Balance amount is the amount remaining on a card or account of cardholder without a decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217: - `detailed_points` BalancePoints - `points_type` 'AMEX', required — Type or name of the points program - `balance_points` string — An amount type represented in points for all fields like points balance, points redemption, etc. when a points program is applicable in a transaciton or a query. - `identifier` string — Identifier associated with the points balance. E.g points_id, account_id. - `points_transaction_reference` string — Unique transaction reference to the related card transaction. - `points_transaction_reference_type` string — Type of the transaction reference. * `AUTH_CODE` The authorisation response code received from issuer/acquirer (as used in the ISO8583 specification (DE 38)) - `points_conversion_rate` number, float — The points conversion rate. - `min_reward_amount` integer — Minimum reward amount to spend with points without a decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. - `max_reward_amount` integer — Maximum reward amount to spend with points without a decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. - `created_at` string, date-time — The time at which the transaction was created. - `customer` string — The ID of a customer - `merchant_reference` string — A reference specified by the merchant to identify the transaction - `invoice_number` string — Optional. The invoice number to track this payment. - `processor` string — The name of the processor used for this transaction - `processor_reference` string — Reference identifying the transaction, as provided by the processor. - `processor_details` object — Stores all details specific for the processor of the transaction. - `status` 'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CANCELLED' | 'CUSTOMER_ACCEPTED' | 'REFUNDED' | 'FAILED' | 'PENDING' | 'DECLINED' | 'SETTLEMENT_CANCELLED' | 'SETTLEMENT_REQUESTED' | 'SETTLEMENT_SUBMITTED' | 'SETTLEMENT_COMPLETED' | 'SETTLEMENT_PARTIAL' | 'SETTLEMENT_DECLINED' | 'VOIDED' | 'UNKNOWN' — The outcome of the payment request. - `status_reason` string — Message provided by the 3rd party service as additional information, when the transaction does not succeed. - `reason_code` string — A reason code assigned by the acquiring platform success - `arn` string — Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions. - `authorization_code` string — Authorization code: * When the payment is authorized successfully, this field holds the authorization code for the payment. * When the payment is not authorized, this field is not returned. - `rrn` string — A client (user friendly) identifier for the transaction generated at the outset of a business event. The format will be dependent on the calling system. A reference supplied by the system retaining the original source information and used to assist in locating that transaction or a copy of the transaction. This value is critical in matching values that are sent to other Payment processors or Acquirers. This value would correspond to the **ISO8583 specification as RRN in attribute DE 37, which limits the value to being an alphanumeric value 12 characters.** For the GSC client android application the format will correspond to YYMMdd. - `shopper_interaction` 'ecommerce' | 'pos' | 'moto' | 'mail_order' | 'cont_auth' | 'telephone_order' | 'unknown' — Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth - `stan` number — System Trace Audit Number. - `promo_code` string — A code defined by the merchant that affects the calculation of the total amount. - `token_details` TokenDetails - `reuse_token` string — The Verifone issued reuse token used to represent the previously stored cardholder data. - `reuse_token_type` 'CHASE' | 'INTERNAL' | 'TAVE' — The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type. - `analytics_token` string — A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes. - `token_expiry_date` string, date — When this Token will expire. - `token_scope` string, uuid — The token scope under which this token was created. - `token_status` 'DELETED' | 'ACTIVE' | 'SUSPENDED' — The status of the Token. - `created_at` string, date — The date when this token was first created. - `updated_at` string, date — The last date token was updated. - `variant` string — The variant of the card. eg. NEW_WORLD - `type` 'CREDIT' | 'DEBIT' — The type of card application or account selection. - `issuer_name` string — The issuer of this card. eg. HSBC, BARCLAYS. - `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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code.
    Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
    . - `brand` string — The brand of this card. eg. VISA, MASTERCARD, AMEX. - `expiry_year` integer — A 4 digit value as shown on card. - `expiry_month` integer — A 2 digit value as shown on card. ISO8583 - DE 14 - `card_holder_name` string — The Card holder name as it appears on the card. - `last_four` string — The last 4 digits of the card number. - `bin` string — The Bank Identification Number (also called IIN - Issuer Identification Number) of this card. - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' — Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). - `card_details` object — This is used to return additional information about the card. - `masked_card_number` string — The masked value for the card number - `expiry_month` integer — Card expiry month. A 2 digit value as shown on card. ISO8583 - DE 14 - `expiry_year` integer — Card expiry year. A 4 digit value as shown on the card. - `additional_data` AdditionalData — Additional payment result data, which may be required to return in a particular payment response. - `acquirer_response_code` string — Acquirer response returned during the authorisation. - `acquirer_response_message` string — The response description generated by the acquirer corresponding to the acquirer response code. - `acquirer_authorizing_network_id` string — The Network ID returned in the original authorization response. - `acquirer_authorizing_network_id_descriptor` string — The name or descriptor that corresponds with the `acquirer_authorizing_network_id` returned in the original authorization response. - `initiator_trace_id` string — A number assigned by a transaction initiator(originator) to assist in identifying a transaction uniquely. The trace identifier remains unchanged for all messages within a two-message exchange, e.g. request/repeat and response. This property can be used to store the System trace audit number (STAN) as used in the ISO8583 specification (DE 11). Note the contents of this field are mandatory in many specifications - ISO8583, AS2805 (DE11) and are often related to the Retrieval Reference Number (RRN) as also specified in ISO8583. Unfortunately due to the usage in these earlier specifications, a STAN was limited to 6 digits which means that it cannot be utilised as a general purpose unique id. In addition, this entry is often printed on the receipt at a POI. This value will correspond to **ISO8583 DE11.** `Note: Use response.stan value for initiator_trace_id` - `settlement_date` string, date — This will reflect either the desired Merchant settlement date or the actual settlement date depending where the transaction request is within the payment lifecycle. A transaction may be assigned an intended settlement date, but it is possible that this date will not occur for technical reasons hence there should be a subsequent event to indicate the actual date of settlement. Format is date only as per RFC 3339. - `issuer_receipt_text` string — Additional text to print on transaction receipt, which optionally may be provided by the Issuer. ## Other responses - `400` — Bad Request - `401` — Unauthorised - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)