Payment Request API
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()
Parameters
None.
Return value
A JSON-serializable plain object containing the following properties:
- PaymentResponse/requestId
- PaymentResponse/methodName
- PaymentResponse/details
- PaymentResponse/shippingAddress
- PaymentResponse/shippingOption
- PaymentResponse/payerName
- PaymentResponse/payerEmail
- PaymentResponse/payerPhone
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):
{
"requestId": "checkout-123",
"methodName": "https://example.com/pay",
"details": {
"transactionId": "12345"
},
"shippingAddress": null,
"shippingOption": null,
"payerName": null,
"payerEmail": null,
"payerPhone": null
}
Specifications
Browser compatibility
See also
- JSON
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
