List payment methods
The endpoint lists all available payment methods that can be transferred in the endpoint orders.
List
Returns a collection of payment methods.
Filtering
You can filter your results as follows:
List payment methods for specified id(s)
/payment-methods?filter[id]=1/payment-methods?filter[id]=1,2,3
List payment methods for specified name(s)
/payment-methods?filter[name]=Invoice/payment-methods?filter[name]=Invoice,Credit Card
List payment methods for specified handle(s)
/payment-methods?filter[handle]=invoice/payment-methods?filter[handle]=invoice,credit-card
Info: See: Pagination, Filtering
AuthorizationbearerAuth
Authorization
bearerAuth API token as bearer token — you receive a test and a live token, there is no switch between them. See Setup → Authentication and Setup → Test mode.
In: header
Query Parameters
Page number to return — see Basic Usage → Pagination.
1Number of objects per page (default 25, maximum 100) — see Basic Usage → Pagination.
value <= 10025List payment methods for specified id(s). Several values are separated by comma, e.g. filter[id]=1,2,3.
List payment methods for specified name(s). Several values are separated by comma, e.g. filter[name]=Invoice,Credit Card.
List payment methods for specified handle(s). Several values are separated by comma, e.g. filter[handle]=invoice,credit-card.
Header Parameters
The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).
"application/json"Value in
- "application/json"
Response Body
application/json
application/json
curl -X GET "https://example.com/payment-methods?filter%5Bid%5D=1&filter%5Bname%5D=Invoice&filter%5Bhandle%5D=invoice" \ -H "Accept: application/json"{ "data": [ { "id": 1, "name": "Invoice", "handle": "invoice", "created_at": "2022-02-01T08:35:45+00:00", "updated_at": "2022-02-01T08:35:45+00:00" }, { "id": 2, "name": "Credit Card", "handle": "credit-card", "created_at": "2022-02-01T08:35:45+00:00", "updated_at": "2022-02-01T08:35:45+00:00" } ], "links": { "first": "https://api.smake.io/v2/payment-methods?page=1", "last": null, "prev": null, "next": "https://api.smake.io/v2/payment-methods?page=2" }, "meta": { "current_page": 1, "from": 1, "path": "https://api.smake.io/v2/payment-methods", "per_page": 25, "to": 25 }}List shipping methods GET
The endpoint lists all available shipping methods that can be transferred in the endpoint [orders](/docs/checkout/2022-02-01/endpoints/orders/createOrder). ## List Returns a collection of shipping methods. ### Filtering You can filter your results as follows: ##### List shipping methods for specified id(s) * `/shipping-methods?filter[id]=1` * `/shipping-methods?filter[id]=1,2,3` ##### List shipping methods for specified name(s) * `/shipping-methods?filter[name]=UPS Standard` * `/shipping-methods?filter[name]=UPS Standard,Pickup` ##### List shipping methods for specified handle(s) * `/shipping-methods?filter[handle]=ups-standard` * `/shipping-methods?filter[handle]=ups-standard,pickup` > **Info:** See: [Pagination](/docs/checkout/2022-02-01/basic/pagination), [Filtering](/docs/checkout/2022-02-01/basic/filtering)
List orders GET
An order is created when the checkout process is complete. > See: [Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects) Returns a collection of created orders. **Filtering** You can filter your results as follows — every `filter[...]` query parameter is documented below (ids can be combined with a comma, e.g. `/orders?filter[id]=1,2,3`). > See: [Pagination](/docs/checkout/2022-02-01/basic/pagination), [Filtering](/docs/checkout/2022-02-01/basic/filtering) **Expanding objects** Related objects can be expanded inline with the `expand` query parameter — all allowed values are listed on the parameter. See [Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects).