SudoSOS Back-end API / stripe/terminal-payment / TerminalPaymentController

Class: TerminalPaymentController

The BaseController class is responsible for:

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

Extends

• BaseController

Constructors

Constructor

new TerminalPaymentController(options): TerminalPaymentController;

Create a new stripe controller instance

Parameters

Parameter	Type	Description
options	BaseControllerOptions	-

Returns

TerminalPaymentController

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

cancelTerminalPayment()

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

DELETE /terminal-payments/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Terminal Payment

Operation Id

cancelTerminalPayment

Tags

terminalPayments - Operations of the Terminal Payment Controller

Security

JWT

---

configureLogger()

protected configureLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

BaseController.configureLogger

---

createTerminalPayment()

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

POST /terminal-payments

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Terminal Payment

Operation Id

createTerminalPayment

Tags

terminalPayments - Operations of the Terminal Payment Controller

Security

JWT

---

getPolicy()

getPolicy(): Policy;

Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.

Returns

Policy

The policy of this controller.

Overrides

BaseController.getPolicy

---

getRouter()

getRouter(): Router;

Returns

Router

the router used by this controller.

Inherited from

BaseController.getRouter

---

getSingleTerminalPayment()

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

GET /terminal-payments/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Terminal Payment

Operation Id

getSingleTerminalPayment

Tags

terminalPayments - Operations of the Terminal Payment Controller

Security

JWT

---

getStripeTerminals()

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

GET /terminal-payments/terminals

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Stripe Terminals

Operation Id

getStripeTerminals

Tags

terminalPayments - Operations of the Terminal Payment Controller

Security

JWT

---

startTerminalPayment()

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

POST /terminal-payments/{id}/process

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

204 - Success

Operation Id

startTerminalPayment

Tags

terminalPayments - Operations of the Terminal Payment Controller

Security

JWT