Skip to main content

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.

Required scope: accounting:write

Grant 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​

OK

Response Headers
    Content-Type