lotuspay/php-sdk

PHP SDK for the Lotuspay REST API

dev-main 2025-08-31 01:04 UTC

This package is auto-updated.

Last update: 2025-09-02 13:46:49 UTC


README

Latest Version on Packagist Total Downloads

O SDK oficial em PHP para interagir com a API da Lotuspay.

Requisitos

Instalação

Você pode instalar o SDK via Composer:

composer require lotuspay/php-sdk

Uso

Primeiro, instancie o cliente com sua chave de API e a URL da API.

<?php
require 'vendor/autoload.php';

use Lotuspay\SDK\Client;
use Lotuspay\SDK\Exception\ApiException;

$lotuspay = new Client('sua_chave_de_api_aqui', 'https://api.lotuspay.me');

Exemplo: Gerar uma cobrança PIX (Cash-in)

try {
    $cashinData = [
        'amount' => 100.50,
        'customer' => [
            'name' => 'Nome Completo do Cliente',
            'email' => 'cliente@email.com',
            'document' => [
                'type' => 'cpf',
                'number' => '12345678900' // Apenas números
            ]
        ],
        'callbackUrl' => 'https://seu-site.com/webhook/lotuspay'
    ];

    $response = $lotuspay->cashin->create($cashinData);

    echo "ID da Transação: " . $response['id'] . "\n";
    echo "QR Code (Copia e Cola): " . $response['qrCode'] . "\n";

} catch (ApiException $e) {
    echo "Erro na API: " . $e->getMessage() . "\n";
    // Para mais detalhes do erro:
    // print_r($e->getErrorDetails());
}

Exemplo: Consultar status de uma transação

try {
    $transactionId = 'abc123def456'; // ID retornado na criação
    $status = $lotuspay->transaction->getStatus($transactionId);

    echo "Status: " . $status['status'] . "\n"; // Ex: "Pending", "Completed", "Failed"

} catch (ApiException $e) {
    echo "Erro na API: " . $e->getMessage() . "\n";
}

Recursos Disponíveis

  • $lotuspay->cashin->create(array $data)
  • $lotuspay->cashout->create(array $data)
  • $lotuspay->sms->send(array $data)
  • $lotuspay->transaction->getStatus(string $publicId)

Consulte a documentação completa da API para ver todos os parâmetros disponíveis para cada método.