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
#Example
GET /payment-methods HTTP/1.1
{
"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
}
}