01.software Docs

Verify a server-issued PaymentSession callback state

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

All HTTP operations
POST
/api/payment-sessions/server/verify-callback

Server write scope. Private, no-store. Same-key exact-binding retries replay after expiry with X-Idempotent-Replay. This operation performs no provider I/O or financial mutation. Never log state or put it in OpenAPI examples.

Authorization

publishableKeyserverSecretKey
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

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

Caller-generated retry identity. Reuse the same key only when retrying the same logical operation.

Match^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|ik_[A-Za-z0-9_-]{22})$
Lengthlength <= 255

Request Body

application/json
  1. body
state*string
paymentSessionId*string
Length1 <= length <= 255
checkoutId*string
Length1 <= length <= 255
provider*string
Value in"toss""portone"
purpose*string
Value in"success""failure"

Response Body

Verify a server-issued PaymentSession callback state result

application/json
  1. response
verified*true
Value intrue
paymentSessionId*string
Length1 <= length <= 255
checkoutId*string
Length1 <= length <= 255
provider*string
Value in"toss""portone"
purpose*string
Value in"success""failure"
expiresAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatdate-time

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/payment-sessions/server/verify-callback' \  -H 'X-Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "state": "string",  "paymentSessionId": "string",  "checkoutId": "string",  "provider": "toss",  "purpose": "success"}'
Example Response
{  "verified": true,  "paymentSessionId": "string",  "checkoutId": "string",  "provider": "toss",  "purpose": "success",  "expiresAt": "2019-08-24T14:15:22Z"}