GET
/
api
/
v2
/
platform
/
payment_methods
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/payment_methods \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "12",
      "type": "payment_method",
      "attributes": {
        "name": "Test",
        "type": "Spree::PaymentMethod",
        "description": null,
        "active": true,
        "display_on": "both",
        "auto_capture": null,
        "position": 1,
        "created_at": "2022-11-08T19:34:47.914Z",
        "updated_at": "2022-11-08T19:34:47.916Z",
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "preferences": {}
      },
      "relationships": {
        "stores": {
          "data": [
            {
              "id": "287",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "13",
      "type": "payment_method",
      "attributes": {
        "name": "Test",
        "type": "Spree::PaymentMethod",
        "description": null,
        "active": true,
        "display_on": "both",
        "auto_capture": null,
        "position": 2,
        "created_at": "2022-11-08T19:34:47.923Z",
        "updated_at": "2022-11-08T19:34:47.924Z",
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "preferences": {}
      },
      "relationships": {
        "stores": {
          "data": [
            {
              "id": "287",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "14",
      "type": "payment_method",
      "attributes": {
        "name": "Test",
        "type": "Spree::PaymentMethod",
        "description": null,
        "active": true,
        "display_on": "both",
        "auto_capture": null,
        "position": 3,
        "created_at": "2022-11-08T19:34:47.929Z",
        "updated_at": "2022-11-08T19:34:47.930Z",
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "preferences": {}
      },
      "relationships": {
        "stores": {
          "data": [
            {
              "id": "287",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "15",
      "type": "payment_method",
      "attributes": {
        "name": "Credit Card",
        "type": "Spree::Gateway::Bogus",
        "description": null,
        "active": true,
        "display_on": "both",
        "auto_capture": null,
        "position": 4,
        "created_at": "2022-11-08T19:34:47.935Z",
        "updated_at": "2022-11-08T19:34:47.937Z",
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "preferences": {
          "dummy_key": "PUBLICKEY123",
          "test_mode": true,
          "server": "test"
        }
      },
      "relationships": {
        "stores": {
          "data": [
            {
              "id": "287",
              "type": "store"
            }
          ]
        }
      }
    },
    {
      "id": "16",
      "type": "payment_method",
      "attributes": {
        "name": "Credit Card",
        "type": "Spree::Gateway::Bogus",
        "description": null,
        "active": true,
        "display_on": "both",
        "auto_capture": null,
        "position": 5,
        "created_at": "2022-11-08T19:34:47.941Z",
        "updated_at": "2022-11-08T19:34:47.943Z",
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "preferences": {
          "dummy_key": "PUBLICKEY123",
          "test_mode": true,
          "server": "test"
        }
      },
      "relationships": {
        "stores": {
          "data": [
            {
              "id": "287",
              "type": "store"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 5,
    "total_count": 5,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/payment_methods?page=1&per_page=&include=&filter[name]=",
    "next": "http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[name]
string

Response

200
application/vnd.api+json
Records returned
​
data
object[]
required
​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue
Apply Coupon Code for an OrderCreate a Payment Method