Class PaymentController

Namespace: Payment.API.Controllers
Assembly: Payment.API.dll

Controller that manage payments.

[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]s")]
public sealed class PaymentController : ControllerBase

Inheritance

object ← ControllerBase ← PaymentController

Inherited Members

Constructors

PaymentController\(IMediator\)

Payment controller constructor, injecting MediatR.IMediator to send requests.

public PaymentController(IMediator mediator)

Parameters

mediator IMediator

The MediatR.IMediator to inject for mediator query handling.

Methods

ClearTablePayments\(TableToCleanFromPaymentsCommand\)

Delete a specific payment by its unique identifier.

[HttpPut("clear-table")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public Task<ActionResult<Payment>> ClearTablePayments(TableToCleanFromPaymentsCommand command)

Parameters

command TableToCleanFromPaymentsCommand

Returns

Task < ActionResult <Payment\>\>

CreatePayment\(CreatePaymentCommand\)

Post a new payment.

[HttpPost]
[ProducesResponseType(typeof(Payment), 201)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public Task<ActionResult<Payment>> CreatePayment(CreatePaymentCommand command)

Parameters

command CreatePaymentCommand

Returns

Task < ActionResult <Payment\>\>

DeletePayment\(Guid\)

Delete a specific payment by its unique identifier.

[HttpDelete("{id}")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<IActionResult> DeletePayment(Guid id)

Parameters

id Guid

Returns

Task < IActionResult \>

GetAllPayments\(\)

Get the list of all payments.

[HttpGet]
[ProducesResponseType(typeof(IEnumerable<Payment>), 200)]
[ProducesResponseType(500)]
public Task<ActionResult<IEnumerable<Payment>>> GetAllPayments()

Returns

Task < ActionResult < IEnumerable <Payment\>\>\>

GetPaymentById\(Guid\)

Get a specific payment by its unique identifier.

[HttpGet("{id}")]
[ProducesResponseType(typeof(Payment), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Payment>> GetPaymentById(Guid id)

Parameters

id Guid

The id of the payment to get.

Returns

Task < ActionResult <Payment\>\>

GetPaymentWithOngoingSession\(Guid, double\)

Check if a payment link already exists on a payment instead of creating a new one.

[HttpGet("customer/{customerId}/retrieve-payment-link/{amount}")]
[ProducesResponseType(typeof(Payment), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<IEnumerable<Payment>>> GetPaymentWithOngoingSession(Guid customerId, double amount)

Parameters

customerId Guid

amount double

Returns

Task < ActionResult < IEnumerable <Payment\>\>\>

GetPaymentsByTableId\(Guid\)

Get the list of all payments by table id.

[HttpGet("table/{tableId}")]
[ProducesResponseType(typeof(IEnumerable<Payment>), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public Task<ActionResult<IEnumerable<Payment>>> GetPaymentsByTableId(Guid tableId)

Parameters

tableId Guid

Returns

Task < ActionResult < IEnumerable <Payment\>\>\>

Last modified: 21 May 2024