Commerce

Payments

Record and manage payments against orders. Supports multiple payment methods and partial payments.

Create a payment

POST

/modules/commerce/orders/{order_id}/payments

commerce:write0.0000053 tokens

Create a payment for an order.

curl

curl -X POST https://api.saasignal.saastemly.com/modules/commerce/orders/{order_id}/payments \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"method":"...","amount":1,"currency":"..."}'

json — 201 Created

{ "status": "ok" }

Path param

Type

Description

order_id required

string

Body field

Type

Description

external_id

string

method required

string

amount required

number

range >0

currency required

string

max 3 chars

gateway

string

gateway_data

any JSON

metadata

object

Error responses

401 Unauthorized

402 Insufficient tokens

429 Rate limited

List payments for an order

GET

/modules/commerce/orders/{order_id}/payments

commerce:read0.0000008 tokens

List payments for an order.

curl

curl https://api.saasignal.saastemly.com/modules/commerce/orders/{order_id}/payments \
  -H "Authorization: Bearer sk_live_..."

json — 200 OK

{ "status": "ok" }

Path param

Type

Description

order_id required

string

Error responses

401 Unauthorized

402 Insufficient tokens

429 Rate limited

Get a payment

GET

/modules/commerce/orders/{order_id}/payments/{payment_id}

commerce:read0.0000008 tokens

Retrieve a single payment.

curl

curl https://api.saasignal.saastemly.com/modules/commerce/orders/{order_id}/payments/{payment_id} \
  -H "Authorization: Bearer sk_live_..."

json — 200 OK

{ "status": "ok" }

Path param

Type

Description

order_id required

string

payment_id required

string

Error responses

401 Unauthorized

402 Insufficient tokens

404 Not found

429 Rate limited

commercePaymentRefund

GET