API DocsDocs

Request Apple Pay Session by Account

Apple Pay — Request Apple Pay Session by Account

3 min readUpdated Apr 7, 2026

POST /api/v1/apple-pay/merchant-session-by-account

Request an Apple Pay merchant session using your accountId — no payment intent required. Use this endpoint for the Encrypted Payloads S2S flow. The origin must match a registered payment page domain. Pass the returned session object to completeMerchantValidation() in the Apple Pay JS API.

Guide: Apple Pay Guide — conceptual walkthrough, flow diagrams, and integration patterns.

#Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer {token} — see Authentication

#Request Body Parameters

FieldTypeRequiredDescription
validationUrlStringYesApple's validation URL provided by the Apple Pay JS API on the client side
originStringYesOrigin of the page requesting the session (e.g. https://checkout.your-site.com). Must match a registered payment page domain.
accountIdLongYesMerchant account ID used to look up the Apple Pay configuration

#Response

Returns an opaque Apple Pay session object as a JSON string. Pass it directly to completeMerchantValidation() in the Apple Pay JS API — do not parse or modify it.

{
  "validationUrl": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
  "origin": "https://checkout.your-site.com",
  "accountId": 825952981806376569
}

#Error Responses

HTTP StatusDescription
400Bad Request — missing or invalid parameters. Check the response body for field-level details.
401Unauthorized — missing, expired, or invalid bearer token. Re-authenticate via POST /api/v1/auth.
404Not Found — merchant not found for the given accountId.
422Unprocessable Entity — Apple Pay is not enabled for the given merchant account.
500Internal Server Error — an unexpected error occurred. Retry with exponential backoff.
curl -X POST https://sandbox.api.exirom.com/api/v1/apple-pay/merchant-session-by-account \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
  "validationUrl": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
  "origin": "https://checkout.your-site.com",
  "accountId": 825952981806376569
}'

#Try It

SandboxTry it
https://sandbox.api.exirom.com/api
Was this helpful?
PreviousPOST /v1/apple-pay/merchant-session
NextPOST /v1/payments/intent