Refresh BigCommerce Transactions

POST 
/api/big-commerce/:integrationInstance/transactions/refresh

Queue a background re-sync of payment transactions from BigCommerce for every order synced on the integration instance. New and changed transactions are upserted, and newly found refunds are reconciled against the matching sales orders.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Bearer token (Personal Access Token). Requires the integrations.sync permission.

No request body. The call returns immediately; only one refresh per integration instance runs at a time, so repeated calls while a refresh is queued are ignored. Use List BigCommerce Transactions afterwards to see the results.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthorized

Response Headers

Content-Type

403

Forbidden

Response Headers

Content-Type

404

Not Found

Response Headers

Content-Type

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.