Skip to main content

Create Storefront Payout Mapping Group

POST 

/api/storefront/payout-mappings/groups

Creates a mapping group for one processor. New groups are global: every store's line types of that processor can use them.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

A mapping group is one accounting document per payout: an invoice group posts a sales invoice (a sales credit when it nets negative), a bill group a supplier bill (a supplier credit when it nets positive). Every tenant starts with two global groups: "Stripe Sales" (invoice) and "Stripe Fees" (bill). Line types in no group post to the fallback invoice or bill.

Authentication: Requires Bearer token and the integrations.update permission. Open to API tokens with the accounting:write scope.

Body:

  • provider (required): stripe.
  • integration_instance_id (required integer): a Storefront integration instance ID.
  • name (required string, max 255).
  • document_type (required): invoice or bill.
  • sort_order (optional integer ≥ 0): defaults to after the processor's last group.

Request​

Responses​

Created

Response Headers
    Content-Type