Skip to main content
GET
/
api
/
v3
/
admin
/
payment_methods
/
types
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: types } = await client.paymentMethods.types()
{
  "data": [
    {
      "type": "bogus",
      "label": "Bogus",
      "description": null,
      "preference_schema": [
        {
          "key": "dummy_key",
          "type": "string",
          "default": "PUBLICKEY123"
        },
        {
          "key": "dummy_secret_key",
          "type": "password",
          "default": null
        }
      ]
    },
    {
      "type": "custom_payment_source_method",
      "label": "Custom Payment Source Method",
      "description": null,
      "preference_schema": []
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Response

200 - application/json

provider types found