Skip to main content

List Payment Method Mappings

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

Returns the Magento 2 -> SKU.io payment-method mapping table for this instance, plus the catalogue of SKU.io payment types that can be mapped to.

The mapping rows are the union of every payment method observed on past imported orders and every persisted mapping — methods seen on orders that are not yet mapped appear with sku_payment_type_id: null, and persisted-but-no-longer-observed methods still appear so stale mappings can be revisited or cleared.

Each mapping row contains:

  • id — the persisted mapping row ID, or null when the method has been observed on orders but not yet mapped.
  • magento_method — the Magento 2 payment method code (e.g. checkmo, paypal_express, banktransfer).
  • magento_method_title — the human-friendly method title observed on orders (falls back to the code).
  • sku_payment_type_id / sku_payment_type_name — the SKU.io payment type the method maps to; null when unmapped.
  • unpaid_disposition — how orders that arrive UNPAID with this payment method are imported: null (inherit the store-level payment-pending policy), open (import normally, no hold), draft (import without allocating stock), or reserve (allocate stock and hold fulfillment until payment arrives, optionally expiring per the store-level reservation expiry).
  • accounting_sync — when this method's orders sync to the connected accounting provider: null (inherit the store-level trigger), always (sync once confirmed regardless of payment), when_paid (sync only after payment arrives), or never (this method's orders are excluded from accounting sync).

Response also includes:

  • data.available_payment_types[] — every active SKU.io payment type (id, name).
  • meta — total_mappings, mapped_count, unmapped_count counters.

Authenticated. Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type