W3cubDocs

/Web APIs

PaymentRequest: id property

The id read-only attribute of the PaymentRequest interface returns a unique identifier for a particular PaymentRequest instance.

When constructing an instance of the PaymentRequest, you are able to supply an custom id. If none is provided, the browser automatically sets the id value to a UUID.

Example

This example shows how to give a PaymentRequest instance a custom id.

js

const details = {
  id: "super-store-order-123-12312",
  total: {
    label: "Total due",
    amount: { currency: "USD", value: "65.00" },
  },
};
const request = new PaymentRequest(methodData, details);
console.log(request.id); // super-store-order-123-12312

The id is then also available in the PaymentResponse returned from the show() method, but under the requestId attribute.

js

const response = await request.show();
console.log(response.requestId === request.id);

// And in serialized form too
const json = response.toJSON();
console.log(json.requestId, response.requestId, request.id);

Value

A string.

Specifications

Specification
Payment Request API 1.1
# dom-paymentrequest-id

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
id 60 16 55 No 47 11.1 No 60 No 44 11.3 8.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/id