BasicCardResponse

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BasicCardResponse dictionary (related to the Payment Request API, although defined in the Basic Card Payment spec) defines an object structure for payment response details such as the number/expiry date of the card used to make the payment, and the billing address.

Properties

BasicCardResponse.cardNumber Read only Secure context
Contains the number of the card used to make the payment.
BasicCardResponse.cardholderName Read only Secure context Optional
Contains the cardholder name of the card used to make the payment.
BasicCardResponse.cardSecurityCode Read only Secure context Optional
Contains the security code of the card used to make the payment.
BasicCardResponse.expiryMonth Read only Secure context Optional
Contains the expiry month of the card used to make the payment.
BasicCardResponse.expiryYear Read only Secure context Optional
Contains the expiry year of the card used to make the payment.
BasicCardResponse.billingAddress Read only Secure context Optional
Contains the billing address of the card used to make the payment.

Examples

In the following example, the PaymentRequest() constructor is used to create a new payment request, which takes three objects as parameters — one containing details of the payment methods that can be used for the payment, one containing details of the actual order (such as items bought and shipping options), and an optional object containing further options.

The first of these three (supportedInstruments in the example below) contains a data property that has to conform to the structure defined by the BasicCardRequest dictionary.

var supportedInstruments = [{
  supportedMethods: 'basic-card',
  data: {
    supportedNetworks: ['visa', 'mastercard', 'amex', 'jcb',
                        'diners', 'discover', 'mir', 'unionpay'],
    supportedTypes: ['credit', 'debit']
  }
}];

var details = {
  total: {label: 'Donation', amount: {currency: 'USD', value: '65.00'}},
  displayItems: [
    {
      label: 'Original donation amount',
      amount: {currency: 'USD', value: '65.00'}
    }
  ],
  shippingOptions: [
    {
      id: 'standard',
      label: 'Standard shipping',
      amount: {currency: 'USD', value: '0.00'},
      selected: true
    }
  ]
};

var options = {requestShipping: true};

try {
  var request = new PaymentRequest(supportedInstruments, details, options);
  // Add event listeners here.
  // Call show() to trigger the browser's payment flow.
  request.show().then(function(instrumentResponse) {
    // Do something with the response from the UI.
  })
  .catch(function(err) {
    // Do something with the error from request.show().
  });
} catch (e) {
  // Catch any other errors.
}

Once the payment flow has been triggered using PaymentRequest.show() and the promise resolves successfully, the PaymentResponse object available inside the fulfilled promise (instrumentResponse above) will have a PaymentResponse.details property that will contain response details. This has to conform to the structure defined by the BasicCardResponse dictionary, and may look something like this:

{
  "cardNumber' : '9999999999999999",
  "cardholderName' : 'Mr. Dick Straw",
  "cardSecurityCode" : "999",
  "expiryMonth" : "07",
  "expiryYear" : "2021",
  "billingAddress" : {
    "country" : "GB",
    // etc. billing address is a PaymentAddress object
  }
}

Specifications

Specification Status Comment
Basic Card Payment
The definition of 'BasicCardResponse' in that specification.
Working Draft Initial definition.

Browser Compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No Yes561 No No ?
cardNumber No Yes561 No No ?
cardholderName No Yes561 No No ?
cardSecurityCode No Yes561 No No ?
expiryMonth No Yes561 No No ?
expiryYear No Yes561 No No ?
billingAddress No Yes561 No No ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No57 Yes561 No ?7.0
cardNumber No57 Yes561 No ?7.0
cardholderName No57 Yes561 No ?7.0
cardSecurityCode No57 Yes561 No ?7.0
expiryMonth No57 Yes561 No ?7.0
expiryYear No57 Yes561 No ?7.0
billingAddress No57 Yes561 No ?7.0

1. From version 56: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

Document Tags and Contributors

Contributors to this page: fscholz, jpmedley, chrisdavidmills
Last updated by: fscholz,