Download the PHP package delfinance/delfinance-api-sdk without Composer

On this page you can find all versions of the php package delfinance/delfinance-api-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of delfinance/delfinance-api-sdk

Informations about the package delfinance-api-sdk

Delfinance SDK (PHP)

SDK oficial da Delfinance para PHP, fornecendo uma interface simplificada para integração com os serviços PIX, Transferências, Cobranças e Webhooks da Delfinance.

Índice

Estrutura do Repositório

Requisitos

Instalação

Instale via Composer:

Início Rápido

Configuração mTLS

Para ambientes de produção, a autenticação via mTLS (Mutual TLS) é obrigatória em algumas operações. Você deve fornecer os caminhos absolutos para o seu certificado público (.pem) e chave privada (.key ou .pem).

Certifique-se de que os arquivos de certificado sejam legíveis pelo processo do PHP.

Funcionalidades

QR Code Estático (Módulo QR Code)

Classe: Delfinance\QrCode\Services\QrCodeService

Funcionalidade Método Descrição
Criar QR Code createStaticQrCode(StaticQrCodeRequest $request) Cria um QR Code PIX estático com ou sem valor fixo
Consultar QR Code getStaticQrCode($transactionIdentifier) Busca informações de um QR Code estático por identificador
Listar Pagamentos getStaticQrCodePayments($identifier) Lista todos os pagamentos recebidos de um QR Code estático
Cancelar QR Code cancelStaticQrCode($transactionIdentifier) Cancela um QR Code estático previamente criado

QR Code Dinâmico Imediato (Módulo QR Code)

Classe: Delfinance\QrCode\Services\QrCodeService

Funcionalidade Método Descrição
Criar QR Code createImmediateQrCode(ImmediateQrCodeRequest $request) Cria um QR Code dinâmico para pagamento imediato com expiração
Consultar QR Code getImmediateQrCode($id) Busca informações de um QR Code dinâmico por ID
Cancelar QR Code cancelImmediateQrCode($id) Cancela um QR Code dinâmico imediato

QR Code Dinâmico com Vencimento (Módulo QR Code)

Classe: Delfinance\QrCode\Services\QrCodeService

Funcionalidade Método Descrição
Criar QR Code createDueDateQrCode(DueDateQrCodeRequest $request) Cria um QR Code dinâmico com data de vencimento e encargos
Consultar QR Code getDueDateQrCode($id) Busca informações de um QR Code com vencimento por ID
Cancelar QR Code cancelDueDateQrCode($id) Cancela um QR Code dinâmico com vencimento

Transferências e Pagamentos (Módulo Transfers)

Classes: Delfinance\Transfers\Services\PixService e Delfinance\Transfers\Services\TransfersService

Funcionalidade Método Serviço Descrição
Inicializar Pagamento (DICT) paymentInitialization(PaymentInitializationRequest $request) PixService Inicializa pagamento via chave PIX (CPF, e-mail, etc.)
Inicializar Pagamento (QR Code) decodeQrCode(DecodeQrCodeRequest $request) PixService Decodifica/Inicializa pagamento via payload de QR Code
Criar Transferência PIX createTransfer(CreateTransferRequest $request, $idempotencyKey) TransfersService Executa transferência PIX após inicialização
Criar Transferência TED createTedTransfer(CreateTedTransferRequest $request, $idempotencyKey) TransfersService Executa transferência TED
Consultar Transferência getTransfer($transferIdentifier) TransfersService Consulta detalhes de uma transferência por ID
Consultar Transferência ted getTedTransfer($transferIdentifier) TransfersService Consulta detalhes de uma transferência por ID

Gerenciamento de Chaves PIX (Módulo Transfers)

Classe: Delfinance\Transfers\Services\PixService

Funcionalidade Método Descrição
Gerar Código de Autenticação generateAuthCode(GenerateAuthCodeRequest $request) Gera código para vincular chave PIX (e-mail/telefone)
Criar Chave PIX createPixKey(CreatePixKeyRequest $request, $idempotencyKey) Cria/vincula uma nova chave PIX à conta
Listar Chaves PIX getPixKeys() Lista todas as chaves PIX vinculadas à conta
Deletar Chave PIX deletePixKey(DeletePixKeyRequest $request, $idempotencyKey) Remove uma chave PIX vinculada à conta

Webhooks (Módulo Webhooks)

Classe: Delfinance\Webhooks\Services\WebhookService

Funcionalidade Método Descrição
Criar Webhook createWebhook(CreateWebhookRequest $request) Registra um novo webhook
Listar Webhooks getAllWebhooks() Lista todos os webhooks registrados
Consultar Webhook getWebhookById($id) Consulta detalhes de um webhook por ID
Atualizar Webhook updateWebhook(UpdateWebhookRequest $request) Atualiza configuração de um webhook
Deletar Webhook deleteWebhook($id) Remove um webhook registrado

Tipos de Eventos Suportados:

Esquemas de Autorização:

Cobranças (Módulo Charges)

Classe: Delfinance\Charges\Services\ChargesService

Funcionalidade Método Descrição
Criar Cobrança createCharge(CreateChargeRequest $request) Cria uma cobrança (Boleto, Boleto+PIX, etc.)
Consultar Cobrança getCharge($correlationId) Busca detalhes de uma cobrança por ID de correlação
Listar Cobranças getCharges($startDate, $endDate, $page, $limit) Lista cobranças com filtros
Atualizar Cobrança updateCharge($correlationId, UpdateChargeRequest $request) Atualiza dados (ex: vencimento) de uma cobrança
Cancelar Cobrança voidCharge($correlationId) Cancela uma cobrança pendente

Pagamentos de Contas (Módulo Charges)

Classe: Delfinance\Charges\Services\ChargesService

Funcionalidade Método Descrição
Consultar Boleto getPaymentInfo($paymentIdentifier) Consulta informações de boleto por código de barras/linha digitável
Pagar Boleto makePayment(MakePaymentRequest $request, $idempotencyKey) Realiza o pagamento de um boleto

Tipos de Cobrança Suportados:

Recursos:

Status de Pagamento:

Exemplos de Uso

Criar QR Code Estático

Criar Cobrança (Boleto + PIX)

Inicializar e Realizar Transferência PIX

Criar Webhook

Consultar e Pagar Boleto

Contribuindo

Para contribuir com o projeto:

  1. Faça um Fork do projeto
  2. Crie uma branch para sua feature (git checkout -b feature/MinhaFeature)
  3. Commit suas mudanças (git commit -m 'Adiciona MinhaFeature')
  4. Push para a branch (git push origin feature/MinhaFeature)
  5. Abra um Pull Request

Documentação Técnica

Para mais detalhes sobre os endpoints e parâmetros, consulte a Documentação da API Delfinance.

All versions of delfinance-api-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
ext-json Version *
ext-curl Version *
ext-mbstring Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package delfinance/delfinance-api-sdk contains the following files

Loading the files please wait ...