PaymentResponse: toJSON() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Want more browser support for this feature? Tell us why.

See full compatibility
Learn more

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

The toJSON() method of the PaymentResponse interface returns a JSON-serializable plain object representing the PaymentResponse object.

The method is automatically called by JSON.stringify() when a PaymentResponse object is encountered during JSON serialization.

Syntax

toJSON()

Return value

A JSON-serializable plain object containing the following properties:

Each property's value is copied as-is. When the returned object is passed to JSON.stringify(), the shippingAddress property is further serialized using PaymentAddress.toJSON() when it is not null.

Examples

Calling toJSON() directly

This example obtains a PaymentResponse object. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.

payment.show().then((paymentResponse) => {
  const json = paymentResponse.toJSON();
  console.log(json); // A plain object
  console.log(typeof json); // "object"
  console.log(json.methodName); // Same value as paymentResponse.methodName
});

Serializing to a JSON string

Within the callback from the previous example, the same object can be serialized using JSON.stringify(), which calls the toJSON() method automatically.

console.log(JSON.stringify(paymentResponse));

This would log a JSON string like so (formatted for readability):

json

{
  "requestId": "checkout-123",
  "methodName": "https://example.com/pay",
  "details": {
    "transactionId": "12345"
  },
  "shippingAddress": null,
  "shippingOption": null,
  "payerName": null,
  "payerEmail": null,
  "payerPhone": null
}