Download the PHP package carecapay/sdk-php without Composer

On this page you can find all versions of the php package carecapay/sdk-php. 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 carecapay/sdk-php

Informations about the package sdk-php

CarecaPay — SDK PHP

SDK oficial da CarecaPay para PHP: cobranças Pix, saldo e webhooks. Sem dependências além de ext-curl/ext-json (PHP 8.1+).

Instalação

Beta: enquanto o pacote não está no Packagist, aponte um repositório path/vcs do Composer para carecapay-sdk-php.

Pré-requisito: a chave privada (obrigatória)

Toda chamada é autenticada pela sua chave secreta (ccp_secret_...), gerada no painel em Chaves de API — ela aparece uma única vez. O construtor exige uma chave privada válida e falha na hora com chave pública, vazia ou de outro formato:

O ambiente vem embutido na chave (ccp_secret_sandbox_... → sandbox, ccp_secret_live_... → produção). Para desenvolvimento local:

Uso

Identificar o pagador é obrigatório — use customer_id (cliente já cadastrado e completo) ou customer inline (cria/completa na hora pelo documento), nunca os dois juntos. Sem nenhum dos dois a API devolve 400 customer_required.

Os arrays devolvidos têm exatamente os shapes da API REST (snake_case).

Clientes

customer na criação da cobrança exige os 4 campos (name, email, phone, document). Pra reaproveitar um cliente já cadastrado (e completo — os 4 campos já preenchidos), use customer_id:

Webhooks (recomendado)

Configure sua URL e um segredo no painel (Webhooks). Cada entrega vem com dois mecanismos de verificação.

Com o SDK (recomendado): assinatura verificada em 1 chamada

Webhooks::constructEvent valida o HMAC (rejeita corpo adulterado e entregas antigas) usando o corpo CRU da requisição (php://input):

Webhooks::verifySignature($payload, $header, $secret) devolve só o booleano. Entregas com mais de 5 minutos são rejeitadas ($toleranceSeconds ajusta).

Sem SDK / mais simples: comparar o token

Todo POST também traz o segredo cru no header X-CarecaPay-Token. É mais simples, mas não detecta corpo adulterado nem repetição de entrega, então exige HTTPS na sua URL:

Erros

Desenvolvimento

All versions of sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-curl Version *
ext-json 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 carecapay/sdk-php contains the following files

Loading the files please wait ...