Skip to main content
GET
/
api
/
v3
/
store
/
orders
/
{order_id}
/
payments
/
{id}
Spree SDK
import { createSpreeClient } from '@spree/sdk'

const client = createSpreeClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const payment = await client.store.orders.payments.get('or_abc123', 'pay_abc123', {
  bearerToken: '<token>',
})
{
  "id": "py_UkLWZg9DAJ",
  "payment_method_id": "pm_UkLWZg9DAJ",
  "state": "checkout",
  "response_code": "12345",
  "number": "PKC5SUNZ",
  "amount": "110.0",
  "display_amount": "$110.00",
  "created_at": "2026-03-05T20:52:35.812Z",
  "updated_at": "2026-03-05T20:52:35.812Z",
  "source_type": "credit_card",
  "source_id": "card_UkLWZg9DAJ",
  "source": {
    "id": "card_UkLWZg9DAJ",
    "cc_type": "visa",
    "last_digits": "1111",
    "month": 12,
    "year": 2027,
    "name": "Spree Commerce",
    "default": false,
    "gateway_payment_profile_id": null
  },
  "payment_method": {
    "id": "pm_UkLWZg9DAJ",
    "name": "Credit Card",
    "description": null,
    "type": "Spree::Gateway::Bogus",
    "session_required": true
  }
}

Authorizations

​
x-spree-api-key
string
header
required

Publishable API key for store access

​
Authorization
string
header
required

JWT token for authenticated customers

Headers

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

Path Parameters

​
order_id
string
required

Order prefix ID

​
id
string
required

Payment ID

Response

payment found

​
id
string
required
​
payment_method_id
string
required
​
state
string
required
​
response_code
string | null
required
​
number
string
required
​
amount
string
required
​
display_amount
string
required
​
created_at
string
required
​
updated_at
string
required
​
source_type
enum<string> | null
required
Available options:
credit_card,
store_credit,
payment_source
​
source_id
string | null
required
​
source
object
required
​
payment_method
object
required