Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.moonpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
URL

https://blocks.moonpay.com/platform/v1/google-pay

​
Requirements

​
Size

The frame container height must be 44px. Width is flexible; the Google Pay button inside the frame uses 100% of the container width.

​
Permissions

The payment permission policy is required. When using a sandboxed iframe, include allow-scripts, allow-popups, allow-same-origin, and allow-forms. See Google Pay inside sandboxed iframe for PCI DSS v4 compliance for details.
Example
<iframe
  src="https://blocks.moonpay.com/platform/v1/google-pay"
  allow="payment"
/>

​
Initialization parameters

PropertyTypeRequiredDescription
clientTokenstring✅The client token returned from the connect flow.
channelIdstring✅A unique identifier for the frame generated on your client. This value is attached to each postMessage payload to help identify messages.

The format of this string is up to you.
signaturestring✅The quote signature from the quote endpoint. Pass signature as returned.
externalTransactionIdstringYour own identifier for the transaction. Stored and associated with the MoonPay transaction for correlation.

​
Events

All events are dispatched using the message pattern described in the frames protocol. Below are the event payloads specific to the Google Pay frame.

​
Outbound events

frame->parent These events are sent from this frame to the parent window.

​
handshake

The frame requests that you open a message channel. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "handshake"
}

​
ready

The frame finished loading and the UI is fully rendered. You can use this to coordinate UI transitions if needed. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "ready"
}

​
complete

The transaction is complete. Use the transaction ID to track status updates (for example, by polling or via webhooks). 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "complete",
  "payload": {
    "transaction": {
      "id": "txn_01",
      "status": "pending"
    }
  }
}

​
challenge

Verification is required before the transaction can proceed. Render the challenge frame at the provided URL. Do not construct the URL yourself — use it as-is. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "challenge",
  "payload": {
    "kind": "frame",
    "url": "https://blocks.moonpay.com/platform/v1/challenge?challengeToken=..."
  }
}

​
error

This event dispatches errors that occur in the flow and, if available, provides steps for recovery. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "error",
  "payload": {
    "code": "configurationError",
    "message": "The frame configuration is invalid."
  }
}
CodeDescription
configurationErrorThe frame configuration is invalid. Check initialization parameters.
quoteExpiredThe quote has expired. Fetch a new quote and send it via setQuote.
invalidQuoteThe quote signature is invalid or malformed.
googlePayUnavailableGoogle Pay is not available in the current environment or browser.
genericAn unexpected error occurred.

​
Inbound events

parent->frame These events are sent from the parent window to this frame.

​
ack

Acknowledge the handshake. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "ack"
}

​
setQuote

Provide a new quote to the frame. Pass signature as returned by the quote endpoint. Upon receiving this event, the frame disables the Google Pay button until the quote is revalidated. 
{
  "version": 2,
  "meta": { "channelId": "ch_1" },
  "kind": "setQuote",
  "payload": {
    "quote": {
      "signature": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  }
}