Embed Sessions

Create an embed session

Create a short-lived bearer token for an approved embedded component running for one of your sub-merchants.

This endpoint is available only to partner OAuth bearer tokens. HTTP Basic authentication is not supported. Use the component identifier documented for the embedded-components package version you install.

Use resolve-api-version: partner-v1 for this request. The resulting embed token is used only with the merchant API version selected by the component.

post/embed-sessions

Request

Base URL
https://app-sandbox.resolvepay.com/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/docs/embed-sessions/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

resolve-api-version'partner-v1' required

Required Partner API version for embed-session issuance.

Request body

partner_merchant_refstring required

Resolve merchant ID or external ID of a sub-merchant that currently belongs to your partner account.

componentstring required

Embedded component to authorize. Use the identifier documented for the installed embedded-components package version.

Response

Short-lived embed session created.

session_idstring required

Persisted session identifier used by Resolve for audit and revocation.

tokenstring required

Short-lived bearer token to provide to the embedded component.

expires_atstring date-time required

When the embed token expires. Mint a new session after this time.

merchant_idstring required

Resolve ID of the sub-merchant scoped into the token.

componentstring required

Embedded component authorized by the session.

capabilitiesstring[] required

Capabilities derived by Resolve for the requested component.

Changes

No recorded changes to this operation across all 1 revision of this API.