01.software Docs

resolveCancelRefund

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/orders/resolve-cancel-refund

Requires an sk01_ write key. Managed refunds cannot be attested through this legacy caller-managed resolver; only the manifest-owned typed reason uses the strict Commerce envelope.

Authorization

serverSecretKey
headerAuthorizationBearer <token>

Public integration credential: opaque sk01_ secret API key only; PAT and Customer JWT are not supported by this scheme. Requires tenant binding and the read or write scope named by the operation.

Header Parameters

X-Idempotency-Key*string

Must exactly match body idempotencyKey; reuse both for recovery.

Length1 <= length

Request Body

application/json
  1. body
orderNumber*string

Order number whose pending cancel refund is being resolved

Length1 <= length
idempotencyKey*string

Stable key for this PG refund result report

Match^[\x21-\x7E]+$
Length1 <= length <= 255
outcome*string

PG refund result reported by the storefront or BFF

Value in"succeeded""failed"
refundedAmount*integer
Range0 <= value <= 9007199254740991
pgProvider*string
Match^[a-z0-9][a-z0-9_-]*$
Length1 <= length
pgRefundId?string
Length1 <= length

Response Body

Successful operation

application/json
  1. response
orderId*string
Length1 <= length
transactionId*string
Length1 <= length
refundTransactionId*string
Length1 <= length
refundedAmount*integer
Range0 < value <= 9007199254740991
refundStatus*"succeeded"
Value in"succeeded"
transactionStatus*string
Value in"paid""refunded"

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/orders/resolve-cancel-refund' \  -H 'X-Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "orderNumber": "string",  "idempotencyKey": "string",  "outcome": "succeeded",  "refundedAmount": 0,  "pgProvider": "string"}'
Example Response
{  "orderId": "string",  "transactionId": "string",  "refundTransactionId": "string",  "refundedAmount": 1,  "refundStatus": "succeeded",  "transactionStatus": "paid"}