Payment Methods (Deprecated)
The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the Payments Overview.
This endpoint is deprecated. Use Get accepted payment methods instead.
The V3 version of this endpoint contains more information about the payment methods each payment gateway accepts. The additional information enables your application and BigCommerce to make the most likely-to-succeed payment request to the gateway, without using extra middleware or making preparatory API calls to the gateway on your end prior to running the payment. Use Get accepted payment methods for a leaner, more optimized application.
To learn more about authenticating Payments endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.
Resources
Webhooks
Payments endpoints
Get All Payment Methods
GET /stores/{store_hash}/v2/payments/methods
Request
Gets the list of enabled payment methods. Default sorting is by payment method, alphabetically from A to Z.
Note
Avoid using this API operation if possible. It is not supported; therefore, all enabled providers may not appear.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- page in query - integer
Request a specific page of results. The value of the limit query parameter determines the number of responses per page.
- limit in query - integer
Set the number of responses per page.
example
Response
Body
codestring
Unique platform-wide code identifying the payment method.
Example: squarev2
namestring
Descriptive name of the payment method.
Example: Square
test_modeboolean
Determines whether the payment gateway is in test mode. Always false for offline payment methods.
Example: false