Retrieve Payment Gateway By Id

Retrieve Payment Gateway By ID

GET/payment_gateways/{id}

Use it in a workflow

Add a step and choose the WooCommerce connector.
Pick the Retrieve Payment Gateway By Id action (under Payment gateways).
Fill in the fields below, then reference the result from later steps as {{retrievePaymentGatewayById.response.data}}.

Request

Path parameters

idstringrequired

ID of payment gateway to return

Response

Returns 200 with an object. Read it in later steps with {{retrievePaymentGatewayById.response.data.<field>}}.

idstring

Payment gateway ID. read-only

titlestring

Payment gateway title on checkout.

descriptionstring

Payment gateway description on checkout.

orderinteger

Payment gateway sort order.

enabledboolean

Payment gateway enabled status.

method_titlestring

Payment gateway method title. read-only

method_descriptionstring

Payment gateway method description. read-only

method_supportsarray<string>

Supported features for this payment gateway. read-only

settingsobject

Payment gateway settings.

json

{
  "id": "string",
  "title": "string",
  "description": "string",
  "order": 0,
  "enabled": false,
  "method_title": "string",
  "method_description": "string",
  "method_supports": [
    "string"
  ],
  "settings": {}
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.

Was this page helpful?