Skip to main content

Bulk Replace Payment Method Mappings

PUT 
/api/magento2/integration-instances/:magento2IntegrationInstance/payment-method-mappings

Bulk-replaces the payment-method mapping set for this instance. Any persisted row whose magento_method is NOT in the supplied payload is deleted; the rest are upserted — so send the complete set of mappings you want kept, not a delta.

Body parameters:

  • mappings (array, required — may be empty to clear all mappings). Each row:
    • mappings.*.magento_method (string, required, max 128) — the Magento 2 payment method code.
    • mappings.*.sku_payment_type_id (integer or null) — the SKU.io payment type to map to; null records the method as known but unmapped.
    • mappings.*.unpaid_disposition (string or null, optional) — per-method override for how orders arriving unpaid with this method are imported: null inherits the store-level payment-pending policy, open imports normally, draft imports without allocating stock, reserve allocates stock and holds fulfillment with an expiry per the store-level reservation settings.
    • mappings.*.accounting_sync (string or null, optional) — per-method override for when this method's orders sync to the accounting provider: null inherits the store-level trigger, always, when_paid, or never.

Returns the same payload as the list endpoint, rebuilt after the update.

Authenticated. Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type