Skip to content

SudoSOS Back-end API / stripe/payment-request / BasePaymentRequestResponse

Interface: BasePaymentRequestResponse ​

PaymentRequest is UUID-keyed. To avoid overloading the id slot (which on other responses is the numeric DB id), the UUID is exposed under a semantically named field, mirroring how QRAuthenticator exposes its UUID as sessionId. The response therefore extends BaseResponseWithoutId (timestamps + version, no id) and declares a uuid of its own.

Properties ​

amount ​

ts
amount: DineroObjectResponse;

cancelledAt ​

ts
cancelledAt: string;

ISO-8601 timestamp the request was cancelled (null if not cancelled).


cancelledBy ​

ts
cancelledBy: BaseUserResponse;

The user that cancelled the request (null if not cancelled).


createdAt? ​

ts
optional createdAt?: string;

ISO-8601 creation timestamp.

Inherited from ​

ts
BaseResponseWithoutId.createdAt

createdBy ​

ts
createdBy: BaseUserResponse;

description ​

ts
description: string;

Optional human-readable description.


expiresAt ​

ts
expiresAt: string;

for ​

ts
for: BaseUserResponse;

fulfilledBy ​

ts
fulfilledBy: BaseUserResponse;

The admin that marked the request paid out-of-band (null for Stripe-settled or unpaid requests).


paidAt ​

ts
paidAt: string;

ISO-8601 timestamp the request was marked paid (null if not paid).


status ​

ts
status: PaymentRequestStatus;

updatedAt? ​

ts
optional updatedAt?: string;

ISO-8601 last update timestamp.

Inherited from ​

ts
BaseResponseWithoutId.updatedAt

uuid ​

ts
uuid: string;

version? ​

ts
optional version?: number;

Optimistic-locking version.

Inherited from ​

ts
BaseResponseWithoutId.version