Skip to main content

List Storefront Payout Mapping Groups

GET 

/api/storefront/payout-mappings/groups

Lists the mapping groups of one processor that a store's payouts can use: the store's own groups and the global ones, creating the default global groups on first use. mappings_count is how many of the processor's line types are in the group.

Required scope: accounting:read

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.

Every call names the processor (provider: stripe) and the store (integration_instance_id). A store sees its own rows plus the global rows every store shares; another store's rows are never reachable.

Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type