ApiDoc BACKEND

CheckoutController extends Controller

Table of Contents

Constants

GST_PERCENT  = 5

Properties

$freeAccessActions  : mixed

Methods

actionCapture()  : mixed
Desc: Captura la orden de Paypal
actionCreate()  : mixed
Desc: Crea una orden de pago. Funciona con método POST.
actionOptions()  : void
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
actionOrders()  : mixed
Desc: Crea ordenes de paypal con monto definido (Solo para nuevas revisiones)
actionRefund()  : mixed
Desc: Solicita una devolución
actionSubtotal()  : array{subtotal: float, num_products: int, shipping: float, totalShipping: float, taxes: int|float, total: float, currency: mixed}
Desc: Carga los datos recibidos y genera un subtotal. Funciona con método POST.
actionUpdateStatus()  : array<string|int, mixed>
Desc: Actualiza el status de la Orden.
actionView()  : mixed
Desc: Ver orden generada por el checkout elegido
behaviors()  : array<string|int, mixed>
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
init()  : void
Desc: Inicializa configuraciones para el controlador.
createAddreesJson()  : array<string|int, mixed>
findShippingFee()  : int|float
Desc: Retorna el costo de envío por ciudad.

Constants

Properties

$freeAccessActions

public mixed $freeAccessActions = ['options', 'subtotal', 'receipt']

Methods

actionCapture()

Desc: Captura la orden de Paypal

public actionCapture(string $id) : mixed

Notes: n/a,

Ref: Paypal::captureOrder()

Date: 2025-08-07, Version: v0.2507.01

Example: n/a

Parameters
$id : string

ID de la orden de Paypal.

actionOrders()

Desc: Crea ordenes de paypal con monto definido (Solo para nuevas revisiones)

public actionOrders() : mixed

Notes: n/a, Ref: n/a

Date: 2025-08-08, Version: v0.2507.01

Example: n/a

actionRefund()

Desc: Solicita una devolución

public actionRefund(string $id) : mixed

Notes: n/a,

Ref: Paypal::refund()

Date: 2025-08-08, Version: v0.2507.01

Example: n/a

Parameters
$id : string

ID del la orden del checkout

actionSubtotal()

Desc: Carga los datos recibidos y genera un subtotal. Funciona con método POST.

public actionSubtotal() : array{subtotal: float, num_products: int, shipping: float, totalShipping: float, taxes: int|float, total: float, currency: mixed}

Notes: Esto se utiliza en el carrito de compras del frontend,

Ref: n/a

Date: 2025-08-07, Version: v0.2507.01

Example: n/a

Return values
array{subtotal: float, num_products: int, shipping: float, totalShipping: float, taxes: int|float, total: float, currency: mixed}

actionUpdateStatus()

Desc: Actualiza el status de la Orden.

public actionUpdateStatus(string $id) : array<string|int, mixed>

Notes: n/a, Ref: n/a

Date: 2025-08-08, Version: v0.2507.01

Example: n/a

Parameters
$id : string

ID generado por el metodo de pago

Return values
array<string|int, mixed>

findShippingFee()

Desc: Retorna el costo de envío por ciudad.

protected findShippingFee(string $state, string $city) : int|float

Notes: n/a, Ref: n/a

Date: 2025-08-07, Version: v0.2507.01

Example: n/a

Parameters
$state : string
$city : string
Return values
int|float

        
On this page

Search results