List payments

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const { data: payments } = await client.orders.payments.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "py_UkLWZg9DAJ",
      "payment_method_id": "pm_UkLWZg9DAJ",
      "response_code": "BGS-343039b69b86",
      "number": "R1001-P1",
      "status": "completed",
      "amount": "110.00",
      "source_type": "credit_card",
      "source_id": "card_UkLWZg9DAJ",
      "source": {
        "id": "card_UkLWZg9DAJ",
        "brand": "visa",
        "last4": "1111",
        "month": 12,
        "year": 2027,
        "name": "Spree Commerce",
        "default": false,
        "gateway_payment_profile_id": null,
        "customer_id": null,
        "payment_method_id": "pm_gbHJdmfrXB",
        "metadata": {},
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:00:00.000Z"
      },
      "metadata": {},
      "avs_response": null,
      "cvv_response_code": null,
      "cvv_response_message": null,
      "gateway_dashboard_payment_url": "https://dashboard.bogus.example/payments/BGS-343039b69b86",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "avs_risky": false,
      "cvv_risky": false,
      "captured_amount": "0.00",
      "order_id": "or_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

orders

{order_id}

payments

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const { data: payments } = await client.orders.payments.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "py_UkLWZg9DAJ",
      "payment_method_id": "pm_UkLWZg9DAJ",
      "response_code": "BGS-343039b69b86",
      "number": "R1001-P1",
      "status": "completed",
      "amount": "110.00",
      "source_type": "credit_card",
      "source_id": "card_UkLWZg9DAJ",
      "source": {
        "id": "card_UkLWZg9DAJ",
        "brand": "visa",
        "last4": "1111",
        "month": 12,
        "year": 2027,
        "name": "Spree Commerce",
        "default": false,
        "gateway_payment_profile_id": null,
        "customer_id": null,
        "payment_method_id": "pm_gbHJdmfrXB",
        "metadata": {},
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:00:00.000Z"
      },
      "metadata": {},
      "avs_response": null,
      "cvv_response_code": null,
      "cvv_response_message": null,
      "gateway_dashboard_payment_url": "https://dashboard.bogus.example/payments/BGS-343039b69b86",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "avs_risky": false,
      "cvv_risky": false,
      "captured_amount": "0.00",
      "order_id": "or_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[avs_response_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`avs_response`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`cvv_response_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`cvv_response_message`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`response_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`state`	One of `checkout`, `processing`, `pending`, `completed`, `failed`, `void`, `invalid`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`status`	One of `checkout`, `processing`, `pending`, `completed`, `failed`, `void`, `invalid`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[order_id_eq]. The same predicates apply.

Prefix	Attributes
`order_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`order_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`order_channel_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`order_customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`order_fulfillments_`	`created_at`, `id`, `number`, `updated_at`
`order_line_items_`	`additional_tax_total`, `adjustment_total`, `cost_price`, `created_at`, `discount_total`, `id`, `included_tax_total`, `non_taxable_adjustment_total`, `order_id`, `pre_tax_amount`, `price`, `quantity`, `tax_category_id`, `taxable_adjustment_total`, `updated_at`, `variant_id`
`order_order_group_`	`created_at`, `currency`, `email`, `id`, `number`, `updated_at`
`order_promotions_`	`code`, `created_at`, `expires_at`, `id`, `kind`, `name`, `path`, `promotion_category_id`, `starts_at`, `updated_at`
`order_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`order_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`order_shipments_`	`created_at`, `id`, `number`, `updated_at`
`order_store_`	`created_at`, `id`, `name`, `updated_at`
`order_tags_`	`created_at`, `id`, `name`, `updated_at`
`payment_method_`	`active`, `created_at`, `id`, `name`, `position`, `storefront_visible`, `type`, `updated_at`

Sort by: amount, avs_response, created_at, cvv_response_code, cvv_response_message, id, response_code, state, status, updated_at. Prefix a field with - to sort descending.

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

Bearer token for admin authentication

Path Parameters

order_id

string

required

Order ID

Query Parameters

expand

string

Comma-separated associations to expand (e.g., payment_method, source). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., amount,status,number,response_code). id is always included.

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

payments found

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters