Payments

Connect a store with credentials

Needs an owner or admin, or a key with comms_payments_manage. Only for workspaces Comms set up before open signup. Everyone else gets 409 shopify_install_required and should open https://apps.shopify.com/comms-by-osis. Use a public Storefront token and the matching webhook signing secret. The Payments API is off until an owner or admin accepts the merchant terms. Until then, this returns 403 payments_api_disabled.

put/payments/shopify

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/payments/shopify
  • Auth: HTTP bearer

Request body

shop_domainstring required
storefront_access_tokenstring required
webhook_secretstring required

Response

Store connected. Your credentials are never sent back.

shop_domainstring required
namestring required

Changes

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