Class RegisterResponse

Immutable wrapper around a registration response.

Invariants:

_raw is a deep clone of the gateway payload, made at construction time.
The wrapper exposes no mutator methods; callers cannot affect SDK state.

Index

Constructors

Methods

getOrderId getUrl redirectResponse getRawResponse

Constructors

constructor

new RegisterResponse(raw: RegisterOrderResponse): RegisterResponse
Validates and deep-clones the gateway payload.
Parameters
- raw: RegisterOrderResponse
Returns RegisterResponse
Throws
SatimUnexpectedResponseError on schema violations.
- Defined in src/responses/register.ts:43

Methods

getOrderId

getOrderId(): string
Returns string
The gateway-assigned order identifier. Always present after construction.
- Defined in src/responses/register.ts:49

getUrl

getUrl(): string
Returns string
The hosted payment form URL.

Throws
SatimMissingDataError when no URL is present. (In practice unreachable because validateRegisterSchema enforces a non-empty formUrl at construction.)
- Defined in src/responses/register.ts:59

redirectResponse

redirectResponse(): Response
Build a Web API 302 redirect to the hosted payment form. Returns a standard Response usable in any Web-API runtime (Cloudflare Workers, Deno, Bun, Node 18+).

Enforces HTTPS and the TRUSTED_SATIM_HOSTNAMES allowlist — the only barrier against a gateway returning a formUrl on an attacker-controlled domain.

Returns Response
Throws
SatimInvalidArgumentError when formUrl is not HTTPS, not on a trusted host, or fails URL parsing.
- Defined in src/responses/register.ts:76

getRawResponse

getRawResponse(): RegisterOrderResponse
Returns RegisterOrderResponse
A shallow copy of the raw gateway response. Suitable for debugging; prefer typed accessors for business logic. Mutating the returned object does not affect this wrapper.
- Defined in src/responses/register.ts:100