Update Unmapped Gateway Hold Setting
PUT/api/shopify/:integrationInstance/payment-method-mappings/hold-setting
Turns "Hold payments from unmapped gateways" on or off for the Shopify store.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
On: a payment through a gateway that is not mapped to a payment type (and is not one Shopify settles itself: Shopify Payments, Shop Pay Installments, gift cards, Shop Cash, Shopify Store Credit) is recorded under the "Unmapped Payment Processor" payment type and waits until the gateway is mapped. Off: it is recorded under "Shopify Payment". Stores connected from now on start with it on; stores connected earlier start with it off. The change applies to payments recorded from now on; nothing already recorded changes.
Authentication: Requires Bearer token.
Body fields:
- hold_unmapped_gateway_payments (boolean, required).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.