Magento2
GET /V1/payments-config/{location}

Get Config.

Path parameters

  • location string Required

    sdk location.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • apple_pay object Required
      Hide apple_pay attributes Show apple_pay attributes object
      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • layout string Required

          Layout

        • color string Required

          Color

        • shape string Required

          Shape

        • label string Required

          Label

        • tagline boolean Required

          ShowTagline

        • height integer Required

          Height

        • use_default_height boolean Required

          Height

      • payment_source string Required

        PaymentSource

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • google_pay object Required
      Hide google_pay attributes Show google_pay attributes object
      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • color string Required

          Color

        • height integer Required

          Height

        • type string Required

          Type

      • payment_source string Required

        PaymentSource

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • hosted_fields object Required
      Hide hosted_fields attributes Show hosted_fields attributes object
      • payment_source string Required

        Payment Source

      • three_d_s string Required

        ThreeDS

      • is_vault_enabled boolean Required

        HasIsVaultEnabled

      • cc_vault_code string Required

        CcVaultCode

      • requires_card_details boolean Required

        RequiresCardDetails

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • smart_buttons object Required
      Hide smart_buttons attributes Show smart_buttons attributes object
      • display_message boolean Required

        CanDisplayMessage

      • display_venmo boolean Required

        Venmo

      • message_styles object Required
        Hide message_styles attributes Show message_styles attributes object
        • layout string Required

          CanDisplayMessage

      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • layout string Required

          Layout

        • color string Required

          Color

        • shape string Required

          Shape

        • label string Required

          Label

        • tagline boolean Required

          ShowTagline

        • height integer Required

          Height

        • use_default_height boolean Required

          Height

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    Hide response attributes Show response attributes object
    • apple_pay object Required
      Hide apple_pay attributes Show apple_pay attributes object
      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • layout string Required

          Layout

        • color string Required

          Color

        • shape string Required

          Shape

        • label string Required

          Label

        • tagline boolean Required

          ShowTagline

        • height integer Required

          Height

        • use_default_height boolean Required

          Height

      • payment_source string Required

        PaymentSource

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • google_pay object Required
      Hide google_pay attributes Show google_pay attributes object
      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • color string Required

          Color

        • height integer Required

          Height

        • type string Required

          Type

      • payment_source string Required

        PaymentSource

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • hosted_fields object Required
      Hide hosted_fields attributes Show hosted_fields attributes object
      • payment_source string Required

        Payment Source

      • three_d_s string Required

        ThreeDS

      • is_vault_enabled boolean Required

        HasIsVaultEnabled

      • cc_vault_code string Required

        CcVaultCode

      • requires_card_details boolean Required

        RequiresCardDetails

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title

    • smart_buttons object Required
      Hide smart_buttons attributes Show smart_buttons attributes object
      • display_message boolean Required

        CanDisplayMessage

      • display_venmo boolean Required

        Venmo

      • message_styles object Required
        Hide message_styles attributes Show message_styles attributes object
        • layout string Required

          CanDisplayMessage

      • button_styles object Required
        Hide button_styles attributes Show button_styles attributes object
        • layout string Required

          Layout

        • color string Required

          Color

        • shape string Required

          Shape

        • label string Required

          Label

        • tagline boolean Required

          ShowTagline

        • height integer Required

          Height

        • use_default_height boolean Required

          Height

      • code string Required

        Code

      • sdk_params array[object] Required

        SDK params

        Hide sdk_params attributes Show sdk_params attributes object
        • name string Required

          Code

        • value string Required

          Config

      • is_visible boolean Required

        Visible

      • sort_order string Required

        Sort Order

      • payment_intent string Required

        Payment intent

      • title string Required

        Title
  • 500

    Internal Server error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/payments-config/{location} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/payments-config/{location}'
Response examples (200) 
{
  "apple_pay": {
    "button_styles": {
      "layout": "string",
      "color": "string",
      "shape": "string",
      "label": "string",
      "tagline": true,
      "height": 42,
      "use_default_height": true
    },
    "payment_source": "string",
    "code": "string",
    "sdk_params": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "is_visible": true,
    "sort_order": "string",
    "payment_intent": "string",
    "title": "string"
  },
  "google_pay": {
    "button_styles": {
      "color": "string",
      "height": 42,
      "type": "string"
    },
    "payment_source": "string",
    "code": "string",
    "sdk_params": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "is_visible": true,
    "sort_order": "string",
    "payment_intent": "string",
    "title": "string"
  },
  "hosted_fields": {
    "payment_source": "string",
    "three_d_s": "string",
    "is_vault_enabled": true,
    "cc_vault_code": "string",
    "requires_card_details": true,
    "code": "string",
    "sdk_params": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "is_visible": true,
    "sort_order": "string",
    "payment_intent": "string",
    "title": "string"
  },
  "smart_buttons": {
    "display_message": true,
    "display_venmo": true,
    "message_styles": {
      "layout": "string",
      "logo": {
        "type": "string"
      }
    },
    "button_styles": {
      "layout": "string",
      "color": "string",
      "shape": "string",
      "label": "string",
      "tagline": true,
      "height": 42,
      "use_default_height": true
    },
    "code": "string",
    "sdk_params": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "is_visible": true,
    "sort_order": "string",
    "payment_intent": "string",
    "title": "string"
  }
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <apple-pay>
    <button-styles>
      <layout>string</layout>
      <color>string</color>
      <shape>string</shape>
      <label>string</label>
      <tagline type="boolean">true</tagline>
      <height type="integer">42</height>
      <use-default-height type="boolean">true</use-default-height>
    </button-styles>
    <payment-source>string</payment-source>
    <code>string</code>
    <sdk-params type="array">
      <sdk-param>
        <name>string</name>
        <value>string</value>
      </sdk-param>
    </sdk-params>
    <is-visible type="boolean">true</is-visible>
    <sort-order>string</sort-order>
    <payment-intent>string</payment-intent>
    <title>string</title>
  </apple-pay>
  <google-pay>
    <button-styles>
      <color>string</color>
      <height type="integer">42</height>
      <type>string</type>
    </button-styles>
    <payment-source>string</payment-source>
    <code>string</code>
    <sdk-params type="array">
      <sdk-param>
        <name>string</name>
        <value>string</value>
      </sdk-param>
    </sdk-params>
    <is-visible type="boolean">true</is-visible>
    <sort-order>string</sort-order>
    <payment-intent>string</payment-intent>
    <title>string</title>
  </google-pay>
  <hosted-fields>
    <payment-source>string</payment-source>
    <three-d-s>string</three-d-s>
    <is-vault-enabled type="boolean">true</is-vault-enabled>
    <cc-vault-code>string</cc-vault-code>
    <requires-card-details type="boolean">true</requires-card-details>
    <code>string</code>
    <sdk-params type="array">
      <sdk-param>
        <name>string</name>
        <value>string</value>
      </sdk-param>
    </sdk-params>
    <is-visible type="boolean">true</is-visible>
    <sort-order>string</sort-order>
    <payment-intent>string</payment-intent>
    <title>string</title>
  </hosted-fields>
  <smart-buttons>
    <display-message type="boolean">true</display-message>
    <display-venmo type="boolean">true</display-venmo>
    <message-styles>
      <layout>string</layout>
      <logo>
        <type>string</type>
      </logo>
    </message-styles>
    <button-styles>
      <layout>string</layout>
      <color>string</color>
      <shape>string</shape>
      <label>string</label>
      <tagline type="boolean">true</tagline>
      <height type="integer">42</height>
      <use-default-height type="boolean">true</use-default-height>
    </button-styles>
    <code>string</code>
    <sdk-params type="array">
      <sdk-param>
        <name>string</name>
        <value>string</value>
      </sdk-param>
    </sdk-params>
    <is-visible type="boolean">true</is-visible>
    <sort-order>string</sort-order>
    <payment-intent>string</payment-intent>
    <title>string</title>
  </smart-buttons>
</root>
Response examples (500) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (500) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>