Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Check processor permissions on a merchant account

Checks Payouts and Balance read without modifying a merchant, its key or checkout.

Checks Payouts and Balance read without modifying a merchant, its key or checkout.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:checkProcessorPermissions
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection merchant_accounts

#Request

FieldTypeWhat it is
namestringMerchant account resource name. Required.

#Response

FieldTypeWhat it is
merchant_accountstringMerchant account resource name.
livemodeboolTrue for a live merchant.
permissionsProcessorReadPermission[]All probes, including unavailable results (not a false success).
check_timetimestampProbe completion time.
warningsstring[]Fixed warnings; missing access does not stop checkout.

#ProcessorReadPermission

FieldTypeWhat it is
permissionstringpayouts or balance (Stripe's Payouts and Balance read permissions). Output only.
statestringgranted, missing (403), or unavailable (no conclusion). Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:checkProcessorPermissions" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"