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

Class: PaymentRequestPublicController

The BaseController class is responsible for:

• Storing route definitions.
• Generating router objects based on the policy.

Extends

• BaseController

Constructors

Constructor

new PaymentRequestPublicController(options): PaymentRequestPublicController;

Parameters

Parameter	Type
options	BaseControllerOptions

Returns

PaymentRequestPublicController

Overrides

BaseController.constructor

Properties

Property	Modifier	Type	Description	Inherited from
roleManager	protected	RoleManager	A reference to the role manager passed in the base controller options.	BaseController.roleManager
specification	public	SwaggerSpecification	A reference to the swagger specification passed in the base controller options.	BaseController.specification

Methods

configureLogger()

protected configureLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

BaseController.configureLogger

---

getPolicy()

getPolicy(): Policy;

Returns the routing policy for this controller.

All endpoints here bypass authentication (policy is async () => true). The controller is mounted before setupAuthentication in src/index.ts.

Returns

Policy

Overrides

BaseController.getPolicy

---

getRouter()

getRouter(): Router;

Returns

Router

the router used by this controller.

Inherited from

BaseController.getRouter

---

returnSinglePaymentRequest()

returnSinglePaymentRequest(req, res): Promise<void>;

GET /payment-requests-public/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Single payment request (trimmed shape)

Operation Id

getPublicPaymentRequest

Tags

paymentRequestsPublic - Unauthenticated share-link surface

---

startPaymentPublic()

startPaymentPublic(req, res): Promise<void>;

POST /payment-requests-public/{id}/start

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Stripe client secret

Operation Id

startPaymentRequestPublic

Tags

paymentRequestsPublic - Unauthenticated share-link surface