{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/digital-wallet-broker/tag/Data-definitions/schema/MerchantTokenMetadata/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/digital-wallet-broker/tag/Data-definitions/schema/MerchantTokenMetadata/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.3\",\"info\":{\"version\":\"1.2.2\",\"title\":\"Digital wallet broker API\",\"description\":\"Use the digital-wallet-broker API to create digital wallet sessions.\",\"contact\":{\"name\":\"payments-digital-integrations\"}},\"servers\":[{\"url\":\"https://ws-dev-api.eng.toasttab.com\"},{\"url\":\"https://ws-preprod-api.eng.toasttab.com\"},{\"url\":\"https://ws-sandbox-api.eng.toasttab.com\"}],\"paths\":{\"/digital-wallet-broker/v1/wallets/apple-pay/payment-session\":{\"post\":{\"summary\":\"Create session for Apple Pay transaction\",\"description\":\"Creates a session for an Apple Pay transaction. The session is used to validate the merchant and initiate the payment process with Apple Pay.\",\"security\":[{\"BearerAuth\":[]},{\"OAuth2\":[\"spi.digital-wallet:write\"]}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ApplePayPaymentSessionRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Successful operation. Apple Pay session created.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}}},\"400\":{\"description\":\"Bad request / Missing required fields.\"},\"403\":{\"description\":\"Your Toast API client does not have permission to create an Apple Pay session.\"},\"500\":{\"description\":\"Internal server error.\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\"},\"OAuth2\":{\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"/authentication/v1/authentication/customer/oauth/token\",\"scopes\":{\"spi.digital-wallet:read\":\"Digital Wallet read access\",\"spi.digital-wallet:write\":\"Digital Wallet write access\"}}}}},\"schemas\":{\"ApplePayPaymentSessionRequest\":{\"type\":\"object\",\"required\":[\"validationURL\",\"domain\"],\"properties\":{\"validationURL\":{\"description\":\"The Apple Pay gateway URL.\",\"type\":\"string\",\"format\":\"uri\"},\"domain\":{\"description\":\"The internet domain name used to submit an Apple Pay payment. The domain must match a domain you registered for your Apple Pay payment integration.\",\"type\":\"string\"},\"paymentMethodDomainId\":{\"description\":\"The identifier of the merchant domain. You can retrieve the `paymentMethodDomainId` from the Toast developer portal.\",\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"sessionSecret\":{\"description\":\"A unique and randomized identifier for the payment intent.\",\"type\":\"string\",\"nullable\":true}}},\"EventType\":{\"type\":\"string\",\"enum\":[\"UNLINK\",\"UPDATED_METADATA\",\"UPDATED_CARD_ART\",\"UPDATED_MERCHANT_TOKEN_PUBLIC_KEY\",\"UNKNOWN\"]},\"CardMetadata\":{\"type\":\"object\",\"properties\":{\"cardCountry\":{\"type\":\"string\",\"nullable\":true},\"expirationDate\":{\"type\":\"string\",\"nullable\":true},\"fpanSuffix\":{\"type\":\"string\",\"nullable\":true},\"longDescription\":{\"type\":\"string\",\"nullable\":true},\"shortDescription\":{\"type\":\"string\",\"nullable\":true}}},\"MerchantTokenMetadata\":{\"type\":\"object\",\"properties\":{\"cardMetadata\":{\"type\":\"object\",\"nullable\":true,\"allOf\":[{\"$ref\":\"#/components/schemas/CardMetadata\"}]}}},\"ApplePayMerchantTokenEventResponse\":{\"type\":\"object\",\"required\":[\"eventType\",\"merchantTokenIdentifier\"],\"properties\":{\"eventType\":{\"$ref\":\"#/components/schemas/EventType\"},\"merchantTokenIdentifier\":{\"type\":\"string\"},\"merchantTokenMetadata\":{\"type\":\"object\",\"nullable\":true,\"allOf\":[{\"$ref\":\"#/components/schemas/MerchantTokenMetadata\"}]}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/digital-wallet-broker/overview/","redocItemId":"tag/Data-definitions/schema/MerchantTokenMetadata","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"requestLogin":false,"lastModified":"2026-10-30T19:48:08.000Z"},"seo":{"title":"MerchantTokenMetadata"}}},"pageContext":{"id":"8b09bac2-88d1-50bf-802b-0f437a646248tag/Data-definitions/schema/MerchantTokenMetadata/__redocly content/digital-wallet-broker/tag/Data-definitions/schema/MerchantTokenMetadata/","seo":{"title":"MerchantTokenMetadata","description":"<SchemaDefinition showWriteOnly={true} schemaRef=\"#/components/schemas/MerchantTokenMetadata\" />","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"digital-wallet-broker.reference.page.yaml#tag/Data-definitions/schema/MerchantTokenMetadata/","pageBaseUrl":"/digital-wallet-broker","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/digital-wallet-broker/tag/Data-definitions/schema/MerchantTokenMetadata/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"digitalWalletBroker","id":"digitalWalletBroker","title":"digitalWalletBroker","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}