Skip to main content

List Storefront Payout Type Mappings

GET 

/api/storefront/payout-mappings/type-mappings

Lists the line types of one processor with the account and mapping group a store resolves for each: the store's own override where one exists, otherwise the global mapping (is_override tells which). The defaults are created on first use: for each category (charge, refund, dispute, dispute_reversal, adjustment, reserve, transfer, other) a gross row in the processor's Sales group and a fee row in its Fees group, plus a standalone-fee row; accounts start unset.

Required scope: accounting:read

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

financial_code identifies the line type: <provider>:<category> for the gross amount, <provider>:<category>:fee for the processor's fee on it. A line type with no account posts to the store's fallback revenue or expense account by its sign.

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