Skip to main content

Re-read Storefront Payout Lines

POST 

/api/storefront/payouts/:storefrontPayout/refresh-lines

Reads one payout and its lines again from the store, now, and returns the payout as Get Storefront Payout does. Use it when a payout's lines were not available at the last sync or look incomplete. The payout's accounting status is re-evaluated; a payout already posted keeps its posted documents.

Required scope: accounting:write

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

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

Errors (422):

  • The store's processor connection lacks a permission it needs (for Stripe, a restricted key without Balance: Read or Payouts: Read): error.code is processor_permission_missing, with the provider and the permission to grant.
  • The store could not be reached or returned an error: message starts with "Could not read the payout from the store".

Request​

Responses​

OK

Response Headers
    Content-Type