{"openapi":"3.1.0","info":{"title":"Admin Payments: Payment Methods V2","version":"1.0.0"},"paths":{"/stores/{store_hash}/v2/payments/methods":{"get":{"operationId":"getAllPaymentMethods","summary":"List Payment Methods","description":"Gets the list of enabled payment methods. Default sorting is by payment method, alphabetically from A to Z.\n\n> #### Note\n> Avoid using this API operation if possible. It is not supported; therefore, all enabled providers may not appear.\n","tags":["methodsDeprecated"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Request a specific page of results. The value of the limit query parameter determines the number of responses per page.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Set the number of responses per page.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | read-only | `store_payments_methods_read` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment_Base"}}}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"payment_Base":{"type":"object","properties":{"code":{"type":"string","description":"Unique platform-wide code identifying the payment method."},"name":{"type":"string","description":"Descriptive name of the payment method."},"test_mode":{"type":"boolean","description":"Determines whether the payment gateway is in test mode. Always false for offline payment methods."}},"title":"payment_Base"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | read-only | `store_payments_methods_read` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}