Paypal extends Component
Service/component for Paypal
Tags
Table of Contents
Properties
- $currencyCode : string
Methods
- captureOrder() : array{status: string, statusCode: string, error: mixed, response: mixed}
- Desc: Captura de la orden de pago.
- createOrder() : array<string|int, mixed>
- Desc: Solicitud de pago a Paypal.
- getAccessToken() : array{status: string, error: mixed, response: mixed}
- Desc: Retorna el access token invocando a generateAccessToken().
- getCaptureDetails() : mixed
- Desc: Solicita detalles de la captura
- getOrderDetails() : mixed
- Desc: Obtiene detalles de la orden de paypal
- refund() : mixed
- Desc: Solicita a Paypal una devolución de una captura hecha.
- generateAccessToken() : array{status: string, error: mixed, response: mixed}
- Desc: Genera un Token de Acceso para las peticiones de Paypal. Utilza las variables de entorno del archivo (.env) para obtener datos sensibles como Paypal client ID y el Paypal client Secret.
Properties
$currencyCode
public
string
$currencyCode
Currency Code
Methods
captureOrder()
Desc: Captura de la orden de pago.
public
captureOrder(string $orderID) : array{status: string, statusCode: string, error: mixed, response: mixed}
Note: n/a,
ref: https://developer.paypal.com/docs/api/orders/v2/#orders_capture
Date: 2025-07-31, Version: v0.2507.01
Example: n/a
Parameters
- $orderID : string
Return values
array{status: string, statusCode: string, error: mixed, response: mixed}createOrder()
Desc: Solicitud de pago a Paypal.
public
createOrder(float $amount, array<string|int, mixed> $customerBilling, string $purchase_description) : array<string|int, mixed>
Note: n/a,
ref: https://developer.paypal.com/docs/api/orders/v2/#orders_create
Date: 2025-07-31, Version: v0.2507.01
Example: n/a
Parameters
- $amount : float
-
Monto a pagar
- $customerBilling : array<string|int, mixed>
-
Array clave valor obtenido del json string del campo
shipping_address - $purchase_description : string
-
Descripcion de la compra
Return values
array<string|int, mixed>getAccessToken()
Desc: Retorna el access token invocando a generateAccessToken().
public
getAccessToken() : array{status: string, error: mixed, response: mixed}
Note: n/a, ref: n/a
Date: 2025-07-31, Version: v0.2507.01
Example: n/a
Return values
array{status: string, error: mixed, response: mixed}getCaptureDetails()
Desc: Solicita detalles de la captura
public
getCaptureDetails(string $captureID) : mixed
Note: n/a,
ref: https://developer.paypal.com/docs/api/payments/v2/#captures_get
Date: 2025-07-31, Version: v0.2507.01
Example: n/a
Parameters
- $captureID : string
getOrderDetails()
Desc: Obtiene detalles de la orden de paypal
public
getOrderDetails(string $orderID) : mixed
Note: n/a,
ref: https://developer.paypal.com/docs/api/orders/v2/#orders_get
Date: 2025-07-31, Version: v0.2507.01
Example: n/a
Parameters
- $orderID : string
refund()
Desc: Solicita a Paypal una devolución de una captura hecha.
public
refund(string $captureID, array<string|int, mixed> $typeConf) : mixed
Note: n/a,
ref: https://developer.paypal.com/docs/api/payments/v2/#captures_refund
Date: 2025-07-31, Version: v0.2507.01
example:
// Ejemplo de cuerpo:
$typeConf = [
'type' => 'FULL', 'data' => [
'payload' => [],
'invoice_id' => 'INVOICE-123',
'note_to_payer' => 'DefectiveProduct',
],
];
//OR
$typeConf = [
'type' => 'PARTIAL', 'data' => [
'amount' => [
'value' => '15.00',
'currency_code' => 'USD'
],
'invoice_id' => 'INVOICE-123',
'note_to_payer' => 'DefectiveProduct',
],
];
Parameters
- $captureID : string
- $typeConf : array<string|int, mixed>
generateAccessToken()
Desc: Genera un Token de Acceso para las peticiones de Paypal. Utilza las variables de entorno del archivo (.env) para obtener datos sensibles como Paypal client ID y el Paypal client Secret.
protected
generateAccessToken() : array{status: string, error: mixed, response: mixed}
Note: n/a,
ref: https://www.paypal.ai/docs/get-started/how-to/use-rest-api/get-api-credentials
Date: 2025-07-31, Version: v0.2507.01
Example: n/a