Skip to main content
PATCH
Spree Admin SDK

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

id
string
required

Payment ID

Body

application/json
amount
string<decimal>

Captures part of the authorized amount. Defaults to all of it.

Pattern: ^-?\d+(\.\d+)?$

Response

payment captured