01.software Docs

Retrieve a custom-provider PaymentSession by provider identity

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

All HTTP operations
POST
/api/orders/custom-payment-sessions/retrieve

Performs an exact server-only lookup by provider session or payment identity and returns only bounded recovery state.

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.

Request Body

application/json
  1. body
provider*string
Match^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$
Length1 <= length <= 64
by*|

Response Body

Retrieve a custom-provider PaymentSession by provider identity result

application/json
  1. response
id*string
Length1 <= length <= 255
provider*string
Match^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$
Length1 <= length <= 64
providerSessionId*string
Match\S
Length1 <= length
providerPaymentId*|
Match\S
Length1 <= length
status*string
Value in"pending""captured""failed""canceled"
providerStatus*string
Value in"requires_payment_method""requires_action""requires_confirmation""initializing""processing""authorized""canceling""unknown""captured""failed""canceled"
finalizationStatus*string
Value in"not_ready""pending""committed"
money*
orderId*|
Length1 <= length <= 255

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/custom-payment-sessions/retrieve' \  -H 'Content-Type: application/json' \  -d '{  "provider": "string",  "by": {    "providerSessionId": "string"  }}'
Example Response
{  "id": "string",  "provider": "string",  "providerSessionId": "string",  "providerPaymentId": "string",  "status": "pending",  "providerStatus": "requires_payment_method",  "finalizationStatus": "not_ready",  "money": {    "amountMinor": 0,    "currency": "string"  },  "orderId": "string"}