Download the PHP package soulpay/soulpay-sdk without Composer
On this page you can find all versions of the php package soulpay/soulpay-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package soulpay-sdk
SoulPay
E-Commerce API SDK
Introdução
Este documento explica como realizar a integração com a API de E-Commerce utilizando nosso SDK em PHP para começar a realizar transações.
Requerimentos
- PHP 7.0+
Instalação com Composer
Vamos Começar
A API é capaz de realizar transações de cartão de crédito, geração de boletos e recorrências diárias, semanais, mensais ou outras escolhas de período.
Ambientes
Para utilizar este SDK em ambiente de teste é necessario colocar o ultimo parametro do construtor de uma request como false, como demonstrado abaixo.
Realizar Login
Para realizar o login é necessário criar um objeto Login, preenche-lo com Email e Password. Logo após, é necessário instanciar a classe LoginRequest e passar o objeto Login (previamente criado) ao método send.
Vejamos um exemplo abaixo
Criando uma Transação
Para criar uma transação é necessário preencher as informações obrigatórias descritas na documentação.
Seguindo a mesma ideia de login, é necessário instanciar os models da transação, sendo esses Customer, Billing, Shipping, CreditCard, CreditInstallment, Payment, CreditCardTransaction.
Para enviar a transação é necessário instanciar CreditCardTransaction onde o token JWT deve ser passado como parâmetro.
Criando uma Recorrência
Para criar uma recorrência é necessário preencher as informações obrigatórias descritas na documentação.
Seguindo a mesma ideia de transação, é necessário instanciar os models da recorrência, sendo esses Customer, Billing, Shipping, CreditCard, Recurring, CreditInstallment, Payment, RecurringTransaction. Para enviar a recorrência é necessário instanciar RecurringRequest onde o token JWT deve ser passado como parâmetro.
Ativando/desativando uma Recorrência
Na edição de recorrência é necessário instanciar a model RecurringStatus. Para enviar a requisição é necessário instanciar RecurringRequest, onde o token JWT deve ser passado como parâmetro.
Gerando Boleto Bancario
Para criar um boleto é necessário preencher as informações obrigatorias descritas na documentação.
Seguindo a mesma ideia de transação é necessário instanciar os models de boleto, sendo esses Customer, Billing, BankSlip, Payment, BankSLipTransaction, BankSlipRequest.
Para enviar o boleto bancario é necessário instanciar BankSlipTransaction onde o token JWT deve ser passado como parâmetro.
Consulta de transações
Para consultar uma transação, é necessário instanciar a classe CreditCardRequest. O Order ID deve ser passado como parâmetro de busca.
Consulta de boletos
Para consultar um boleto, é necessário instanciar a classe BankSlipRequest. O Order ID deve ser passado como parâmetro de busca.
Consulta de recorrências
Para consultar uma recorrência, é necessário instanciar a classe RecurringRequest. O Order ID deve ser passado como parâmetro de busca.