Skip to main content

Export Storefront Payout Type Mappings

GET 

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

Downloads one processor's payout type mappings for a store as a CSV file, one row per financial code, ordered by financial code. Each row shows the mapping the store uses: its own where it has one, otherwise the global one.

Required scope: accounting:read

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

Columns:

  • Financial Code: the line type (for example stripe:charge, stripe:charge:fee).
  • Nominal Code: the account as code - name (for example 4000 - Online Store Sales), blank when unmapped.
  • Mapping Group: the group name, blank when none is assigned.

The file uses the columns Import Storefront Payout Type Mappings reads, so it can be edited and uploaded again.

Response: text/csv file download (storefront-<provider>-payout-type-mappings-YYYY-MM-DD_HHMMSS.csv), not JSON.

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

Request​

Responses​

OK

Response Headers
    Content-Type