Skip to content
/Embed Sessions

Embed Sessions

Operations

Create an embed session

Request

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.

Security
bearerAuth
Headers
resolve-api-versionstringrequired

Required Partner API version for embed-session issuance.

Value:"partner-v1"
Bodyapplication/jsonrequired
partner_merchant_refstringrequired

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

componentstringrequired

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

curl -i -X POST \
  https://docs.resolvepay.com/_mock/partners-api/openapi/embed-sessions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'resolve-api-version: partner-v1' \
  -d '{
    "partner_merchant_ref": "child-merchant-external-id",
    "component": "payments"
  }'

Responses

Short-lived embed session created.

Bodyapplication/json
session_idstringrequired

Persisted session identifier used by Resolve for audit and revocation.

tokenstringrequired

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_idstringrequired

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

componentstringrequired

Embedded component authorized by the session.

capabilitiesArray of stringsrequired

Capabilities derived by Resolve for the requested component.

Response
{
  "session_id": "es_123",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2026-08-27T15:30:00.000Z",
  "merchant_id": "merchant_123",
  "component": "payments",
  "capabilities": [
    "payments:read"
  ]
}