POST
/
api
/
v2
/
platform
/
payment_methods
curl --request POST \
  --url http://{defaultHost}/api/v2/platform/payment_methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method": {
    "name": "Test Payment Method",
    "active": true,
    "auto_capture": true,
    "description": "This is a test payment method",
    "type": "Spree::Gateway::Bogus",
    "display_on": "both",
    "store_ids": [
      "2"
    ],
    "public_metadata": {},
    "private_metadata": {}
  }
}'
{
  "data": {
    "id": "24",
    "type": "payment_method",
    "attributes": {
      "name": "API Bogus",
      "type": "Spree::Gateway::Bogus",
      "description": null,
      "active": true,
      "display_on": "both",
      "auto_capture": null,
      "position": 3,
      "created_at": "2022-11-08T19:34:48.527Z",
      "updated_at": "2022-11-08T19:34:48.530Z",
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {},
      "preferences": {
        "dummy_key": "PUBLICKEY123",
        "test_mode": true,
        "server": "test"
      }
    },
    "relationships": {
      "stores": {
        "data": [
          {
            "id": "291",
            "type": "store"
          },
          {
            "id": "292",
            "type": "store"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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>

Body

application/json
​
payment_method
object
required

Response

201
application/vnd.api+json
Record created
​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Return a list of Payment MethodsReturn a Payment Method