Download the PHP package maikealame/moip-sdk-php without Composer

MoIP v2 PHP client SDK [FORK]

O repositório atual não está sendo mantido desde 2018, aqui você poderá contribuir com a atualização pela documentação oficial atualmente

O jeito mais simples e rápido de integrar o Moip a sua aplicação PHP

Estado atual do sdk

Estatísticas

Versões

Índice

• Instalação
• Configurando a autenticação
  • Por BasicAuth
  • Por OAuth
• Exemplos de Uso:
  • Clientes
  • Criação
  • Consulta
  • Adicionar cartão de crédito
  • Deletar cartão de crédito
  • Pedidos
  • Criação
  • Consulta
    • Pedido Específico
    • Todos os Pedidos
    • Sem Filtro
    • Com Filtros
    • Com Paginação
    • Consulta Valor Específico
  • Pagamentos
  • Criação
    • Cartão de Crédito
    • Inserir dados do portador
    • Com Hash
    • Com Dados do Cartão
    • Com Boleto
    • Com Débito Bancário
  • Consulta
  • Capturar pagamento pré-autorizado
  • Cancelar pagamento pré-autorizado
  • Reembolsos
  • Cartão de crédito
    • Valor Total
    • Valor Parcial
  • Conta bancária
    • Valor Total
    • Valor Parcial
  • Consulta
  • OAuth (Moip Connect)
  • Solicitar permissões de acesso ao usuário
  • Gerando access token OAuth
  • Multipedidos
  • Criação
  • Consulta
  • Multipagamentos
  • Criação
  • Consulta
  • Conta Moip
  • Criação
  • Consulta
  • Consulta
  • Verifica se usuário já possui Conta Moip
  • Obter chave pública de uma Conta Moip
  • Saldo Moip
  • Consulta
  • Conta Bancária
  • Criação
  • Consulta
  • Listagem
  • Atualização
  • Deletar
  • Transferência
  • Criação
  • Consulta
  • Listagem
  • Reversão
  • Preferências de Notificação
  • Criação
  • Consulta
  • Exclusão
  • Listagem
  • Webhooks
  • Consulta
• Packages
• Tratamento de exceções
• Documentação
• Testes
• Licença

Packages

• Laravel 5.x
• Symfony 2 ou 3
• Laravel 4.x (MoIP API v1)

Dependências

require

• PHP >= 5.5
• rmccue/requests >= 1.0

require-dev

• phpunit/phpunit ~ 4.0

Instalação

Execute em seu shell:

composer require moip/moip-sdk-php

Configurando a autenticação

Por Basic Auth

Por OAuth

Clientes

Criando um comprador

Nesse exemplo será criado um pedido com dados do cliente - Com endereço de entrega e de pagamento.

Consultando os dados de um comprador

Adicionar cartão de crédito

Deletar cartão de crédito

Pedidos

Criando um pedido com o comprador que acabamos de criar

Nesse exemplo com vários produtos e ainda especificando valor de frete, valor adicional e ainda valor de desconto.

Consultando um pedido

Pedido específico

Todos os Pedidos

Sem Filtro

Com Filtros

Com Paginação

Consulta Valor Específico

Também é possível usar paginação, filtros e consulta de valor específico juntos

Pagamentos

Criação

Cartão de crédito

Após criar o pedido basta criar um pagamento nesse pedido.

Inserir dados do portador

Para realizar o pagamento, via cartão de crédito, utilizando o cartão de um terceiro (quando o cliente não é o portador do cartão que será utilizado), é necessário que estes dados sejam diferenciados e informados corretamente, para cada etapa do fluxo.

Com hash

Para mais detalhes sobre a geração de hash com os dados do cartão consulte a documentação.

Com dados do cartão

Esse método requer certificação PCI. Consulte a documentação.

Criando um pagamento com boleto

Criando um pagamento com Débito Bancário

No pagamento por débito bancário online também são enviados apenas 3 parâmetros:

• URL do logo que você deseja que apareça, representada abaixo com a variável: $return_uri;
• Data de vencimento, representada pela variável $expiration_date;
• Número do banco representado pela variável $bank_number (atualmente único valor possível é 341, referente ao Banco Itaú).

Consulta

Capturar pagamento pré-autorizado

Cancelar pagamento pré-autorizado

O método avoid usado para cancelamento de pagamentos pré-autorizados foi substituído por cancel.

Reembolsos

Para fazer reembolsos é necessário ter o objeto **** do pagamento que você deseja reembolsar ou passar apenas o ID do pagamento.

Cartão de crédito

Valor Total

Com o objeto

Valor Parcial

Com o objeto

Conta bancária

Valor Total

Com o objeto

Valor Parcial

Com o objeto

Consultar reembolso

OAuth (Moip Connect)

Solicitar permissões de acesso ao usuário

Para solicitar as permissões você deverá invocar o método getAuthUrl (que monta a URL) e redirecionar o usuário para a URL gerada. O usuário deverá conceder a permissão e então ele será redirecionado para a URL determinada pelo seu App e passada como atributo para o objeto Connect.

A URL passada como atributo deve ser exatamente a mesma que foi cadastrada na criação do APP, caso haja alguma divergência o usuário não será redirecionado corretamente.

Com a permissão concedida, você receberá um code que lhe permitirá gerar o accessToken de autenticação e processar requisições envolvendo outro usuário.

Gerando access token OAuth

Abaixo usaremos o método authorize para gerar o access token OAuth. Note que é necessário instanciar o objeto Connect e passar os parâmetros como no exemplo abaixo.

Usamos a variável $code para enviar o code recebido pela permissão do usuário e inserimos no objeto com o método setCode.

A URL passada como atributo deve ser exatamente a mesma que foi cadastrada na criação do APP, caso haja alguma divergência não será possível recuperar o accessToken.

Multipedidos

Criando um multipedido

Consultando um multipedido

Multipagamentos

Criando um multipagamento

Consulta

Conta Moip

Criação

Consulta

Verifica se usuário já possui conta Moip

Obter chave pública de uma Conta Moip

Saldo Moip

O Saldo é a composição de valores atuais disponíveis, indisponíveis (bloqueados) e futuros de uma determinada Conta Moip.

Esta API está na versão 2.1, contendo o header Accept, com o valor application/json;version=2.1.

Consultar saldos

Requer autenticação OAuth.

Conta Bancária

A Conta bancária é o domicílio bancário de uma determinada Conta Moip. Esta API permite a criação, a consulta e a alteração dos dados de uma Conta Bancária.

Criar Conta Bancária

Consultar Conta Bancária

Listar Contas Bancárias

Atualizar Conta Bancária

Deletar Conta Bancária

Preferências de notificação

Criação

Consulta

Exclusão

Listagem

Webhooks

O PHP, por padrão, está preparado para receber apenas alguns tipos de content-type (application/x-www-form-urlencoded e multipart/form-data). A plataforma do Moip, no entanto, envia dados no formato JSON, o qual a linguagem não está preparada para receber por padrão. Para receber e acessar os dados enviados pelo Moip, você precisa adicionar o seguinte código ao seu arquivo que receberá os webhooks:

Consulta

Sem paginação ou filtro por resource/evento

Com paginação e filtros por resource/evento

Transferência

A Transferência é uma movimentação de fundos entre uma Conta Moip e outra conta de pagamento (pode ser uma Conta bancária ou uma determinada Conta Moip).

Criando/executando uma transferência

Por conta bancária

Para realizar uma transferência utilizando uma conta bancária já cadastrada:

Consultar transferência

Listar transferências

Sem paginação

Com paginação

Reverter transferência

Tratamento de Exceções

Quando ocorre algum erro na API, é lançada a exceção UnexpectedException para erros inesperados, UnautorizedException para erros de autenticação e ValidationException para erros de validação.

Documentação

Documentação oficial

Testes

Por padrão os testes não fazem nenhuma requisição para a API do Moip. É possível rodar os testes contra o ambiente de Sandbox do moip, para isso basta setar a variável de ambiente:

• MOIP_ACCESS_TOKEN Token de autenticação do seu aplicativo Moip.

Como registrar seu aplicativo Moip

Para registrar seu aplicativo Moip você precisará de suas chaves de acesso. Como obter suas chaves de acesso.

Exemplo:

Licença

The MIT License

Comunidade Slack

Tem dúvidas? Fale com a gente no Slack!