Documentación para desarrolladores

SDK PHP de Buyesia Pay

Esta guía muestra la estructura prevista del SDK PHP. En este momento la integración funcional y soportada en producción está disponible únicamente mediante REST API.

Versión del SDK
1.2.0
SDK Payment SDK Amount SDK Transaction SDK RedirectUrls
SDK REST WooCommerce Shopify Próximamente

Resumen

El SDK PHP encapsula el flujo de creación de pagos en objetos reutilizables para que puedas construir el checkout sin manejar manualmente cada request HTTP.

1. Define el monto

Amount

Configura total y currency en un objeto dedicado antes de construir la transacción.

2. Prepara el checkout

Transaction + RedirectUrls

Relaciona la orden y las URLs de retorno para éxito y cancelación.

3. Crea y redirige

Payment

Usa las credenciales del merchant SDK, crea el pago y redirige al approvedUrl devuelto por el SDK.

Instalación

El flujo recomendado es descargar el paquete, instalar dependencias y cargar las clases antes de construir el pago.

1

Descarga el SDK

Obtén el paquete oficial desde esta documentación y extráelo dentro de tu proyecto PHP.

2

Instala dependencias

Ejecuta Composer dentro de la raíz del SDK para generar el autoload y resolver dependencias.

3

Carga las clases del SDK

Importa Amount, Transaction, RedirectUrls y Payment antes de construir el flujo del checkout.

Bootstrap PHP
require __DIR__ . '/vendor/autoload.php';

use BuyesiaPay\Sdk\Amount;
use BuyesiaPay\Sdk\Payment;
use BuyesiaPay\Sdk\RedirectUrls;
use BuyesiaPay\Sdk\Transaction;
Comandos Composer
composer clear-cache
composer install
composer dump-autoload

Monto

Amount define el total y la currency del cobro. Debes usar un código de moneda válido dentro de las monedas habilitadas para tu merchant.

Ejemplo Amount
$amount = new Amount();
$amount->setTotal(100.00)
    ->setCurrency('USD');

Transacción

Transaction es el recurso donde se vincula el objeto Amount y se prepara el contexto de la orden antes de crear el pago final.

Ejemplo Transaction
$transaction = new Transaction();
$transaction->setAmount($amount);

URL de redirección

Define las URLs a las que Buyesia Pay redirigirá al comprador cuando el pago se complete o se interrumpa.

Método Uso
setSuccessUrl() URL del merchant para un pago completado exitosamente.
setCancelUrl() URL del merchant para un pago cancelado o abandonado.
Ejemplo RedirectUrls
$redirectUrls = new RedirectUrls();
$redirectUrls->setSuccessUrl('https://merchant.example/success')
    ->setCancelUrl('https://merchant.example/cancel');

Pago

Payment es el objeto principal. Recibe credenciales, redirectUrls y transaction; luego crea el pago y devuelve la URL aprobada del checkout.

Ejemplo Payment
$payment = new Payment();
$payment->setCredentials([
    'client_id' => 'tu_client_id',
    'client_secret' => 'tu_client_secret',
])->setRedirectUrls($redirectUrls)
  ->setTransaction($transaction);

try {
    $payment->create();
    header('Location: ' . $payment->getApprovedUrl());
    exit;
} catch (Exception $exception) {
    print $exception;
}

Configuración

Si el SDK no refleja cambios después de instalarlo o actualizarlo, ejecuta estos comandos para reconstruir caché y autoload.

Mantenimiento Composer
composer clear-cache
composer install
composer dump-autoload