Download the PHP package nokitua/moip-php without Composer

SDK Moip-PHP - API

O Moip-PHP � uma biblioteca que implementa uma camada de abstra��o para gera��o do XML de instru��es do Moip, permitindo que voc� integre aos servi�os de API sem poluir seu c�digo com v�rias linhas de XML. Um exemplo r�pido:

include_once "autoload.inc.php";

$moip = new Moip();
$moip->setEnvironment('test');
$moip->setCredential(array(
    'key' => 'ABABABABABABABABABABABABABABABABABABABAB',
    'token' => '01010101010101010101010101010101'
    ));

$moip->setUniqueID(false);
$moip->setValue('100.00');
$moip->setReason('Teste do Moip-PHP');

$moip->validate('Basic');

print_r($moip->send());

O Moip-PHP utiliza o padr�o Fluent Interfaces, portanto, voc� pode fazer o exemplo acima da seguinte forma:

include_once "autoload.inc.php";

$moip = new Moip(); 
print_r($moip->setEnvironment('test')
        ->setCredential(array(
    'key' => 'ABABABABABABABABABABABABABABABABABABABAB',
    'token' => '01010101010101010101010101010101'
    ))->setUniqueID(false)
        ->setValue('100.00')
        ->setReason('Teste do Moip-PHP')
        ->validate('Basic')
        ->send());

M�todos dispon�veis

Veja baixo rela��o e detalhes dos m�todos dispon�veis que voc� poder� utilizar com o Moip-PHP.

Moip()

M�todo construtor.

Moip()

$moip = new Moip();

setEnvironment()

M�todo que define o ambiente em qual o requisi��o ser� processada, 'test' para definir que ser� em ambiente de testes Moip o Sandbox, a omiss�o desse m�todo define que a requisi��o dever� ser processada em ambiente real, de produ��o Moip.

Importante: ao definir o ambiente certifique-se de que est� utilizando a autentica��o correspondente ao ambiente, no Moip cada ambiente possui suas pr�pria chaves de autentica��o API.

setEnvironment($environment) $environment : String ('test')

$moip->setEnvironment('test');

setCredential()

O Moip requer que voc� se autentique para que seja possivel processar requisi��es em sua API, para isso antes de realizar qualquer requisi��o voc� dever� informar ao Moip suas credenciais da API formados por um TOKEN e uma KEY.

O par�metro $credencials � um array associativo contendo as chaves key e token (ex: array('key'=>'sua_key','token'=>'seu_token')). Se voc� ainda n�o possui estes dados, veja como obtelas tarv�s em sua conta Sandbox.

setCredential($credential)

$credential : Array('key','token')

$moip->setCredential(array(
        'key' => 'SUA_KEY',
        'token' => 'SEU_TOKEN'
        ));

validate()

O m�todo validate() ir� realizar a valida��o dos dados obrigat�rios para o tipo de instru��o que voc� deseja processar, voc� pode optar por um dos dois n�veis de valida��o dispon�veis o 'Basic' e 'Identification'.

1. Basic : Ir� realizar a valida��o dos dados m�nimos de para uma requisi��o XML ao Moip.

2. Identification : Ir� validar os dados necess�rios para se processar um XML com identifica��o Moip, usados geralmente para redirecionar o cliente j� no segundo step da pagina de pagamento no checkout Moip ou usar o Moip Transparente.

   validate($validateType)

   $validateType : String ('Basic' ou 'Identification')

   $moip->validate('Identification');

setUniqueID()

O m�todo setUniqueID() atribui valor a tag "<IdProprio>" no XML Moip.

1. <IdProprio>: Seu identificador �nico de pedido, essa mesma informa��es ser� enviada para voc� em nossas notifica��es de altera��es de status para que voc� possa identificar o pedido e tratar seu status.

setUniqueID($id)

$id : String

$moip->setUniqueID('ABCD123456789');

setValue()

O m�todo setValue() atribui valor a tag "<Valor>" no XML Moip.

1. <Valor>: Respons�vel por definir o valor que dever� ser pago.

setValue($value)

$value : Numeric

$moip->setValue('100.00');  

setAdds()

O m�todo setAdds() atribui valor a tag "<Acrescimo>" no XML Moip.

1. <Acrescimo>: Respons�vel por definir o valor adicional que dever� ser pago.

setAdds($value)

$value : Numeric

$moip->setAdds('15.00');    

setDeduct()

O m�todo setDeduct() atribui valor a tag "<Deducao>" no XML Moip.

1. <Deducao>: Respons�vel por definir o valor de desconto que ser� subtra�do do total a ser pago.

setDeduct($value)

$value : Numeric

$moip->setDeduct('15.00');

setReason()

O m�todo setReason() atribui valor a tag "<Razao>" no XML Moip.

1. <Razao>: Respons�vel por definir o motivo do pagamento.
2. Este campo � sempre obrigat�rio em um instru��o de pagamento.

setReason($value)

$value : String

$moip->setReason('Pagamento de teste do Moip-PHP');

setPayer()

O m�todo setPayer() atribui valores ao nodo "<Pagador>" no XML Moip.

1. <Pagador>: Nodo de informa��es de quem est� realizando o pagamento.
2. name : <Nome> : Nome completo do pagador
3. email : <Email> : E-mail do pagador
4. payerId : <IdPagador> : Identificados unico do pagador
5. identity : <Identidade> : Identidade do pagador (CPF)
6. phone : <TelefoneCelular> : Telefone de contato secund�rio do pagador
7. billingAddress : <EnderecoCobranca> : Endere�o do pagador
8. address : <Logradouro> : Logradouro do pagador, rua, av, estrada, etc.
9. number : <Numero> : Numero residencial do pagador
10. complement : <Complemento> : Complemento do endere�o do pagador
11. city : <Cidade> : Cidade do endere�o do pagador
12. neighborhood : <Bairro> : Bairro do endere�o do pagador
13. state : <Estado> : Estado do endere�o do pagador em formato ISO-CODE (UF)
14. country : <Pais> : Pais do pagador em formato ISO-CODE
15. zipCode : <CEP> : CEP de endere�o
16. phone : <TelefoneFixo> : Telefone de contato do pagador

setPayer($value)

$value : Array ('name','email','payerId','identity', 'phone','billingAddress' => Array('address','number','complement','city','neighborhood','state','country','zipCode','phone'))

addPaymentWay()

O m�todo addPaymentWay() atribui valor a tag "<FormaPagamento>" do nodo "<FormasPagamento>" no XML Moip.

<FormaPagamento>: Define quais as formas de pagamento que ser�o exibidas ao pagador no Checkout Moip.

1. billet : Para disponibilizar a op��o "Boleto Banc�rio" como forma de pagamento no checkout Moip.
2. financing : Para disponibilizar a op��o "Financiamento" como forma de pagamento no checkout Moip.
3. debit : Para disponibilizar a op��o "Debito em conta" como forma de pagamento no checkout Moip.
4. creditCard : Para disponibilizar a op��o "Cart�o de Cr�dito" como forma de pagamento no checkout Moip.
5. debitCard : Para disponibilizar a op��o "Cart�o de d�bito" como forma de pagamento no checkout Moip.

addPaymentWay($way)

$way : String ('billet','financing','debit','creditCard','debitCard')

$moip->addPaymentWay('creditCard');
$moip->addPaymentWay('billet');
$moip->addPaymentWay('financing');
$moip->addPaymentWay('debit');
$moip->addPaymentWay('debitCard');

setBilletConf()

O m�todo setBilletConf() atribui valores ao node "<Boleto>" no XML Moip que � respons�vel por definir as configura��es adicionais e personaliza��o do Boleto banc�rio.

1. $expiration : Data em formato "AAAA-MM-DD" ou quantidade de dias.
2. $workingDays : Caso "$expiration" seja quantidade de dias voc� pode definir com "true" para que seja contado em dias úteis, o padr�o ser� dias corridos.
3. $instructions : Mensagem adicionais a ser impresso no boleto, at� tr�s mensagens.
4. $uriLogo : URL de sua logomarca, dimensões m�ximas 75px largura por 40px altura.

setBilletConf($expiration, $workingDays, $instructions, $uriLogo)

$expiration : Int ou Date

$workingDays : Boolean

$instructions : Array()

$uriLogo : String

$moip->setBilletConf("2011-04-06",
            false,
            array("Primeira linha",
                "Segunda linha",
                "Terceira linha"),
            "http://seusite.com.br/logo.gif");

addMessage()

O m�todo addMessage() atribui valor a tag "<Mensagem>" do node "<Mensagens>" no XML Moip.

1. <Mensagens>: Node com "<Mensagens>".
2. <Mensagem>: TAG que define mensagem adicional a ser exibida no checkout Moip.

addMessage($msg)

$msg : String

$moip->addMessage('Seu pedido contem os produtos X,Y e Z.');

setReturnURL()

O m�todo setReturnURL() atribui valor a tag "<URLRetorno>" no XML Moip, respons�vel por definir a URL que o comprador ser� redirecionado ao finalizar um pagamento atrav�s do checkout Moip.

setReturnURL($url)

$url : String

$moip->setReturnURL('https://meusite.com.br/cliente/pedido/bemvindodevolta');

setNotificationURL()

O m�todo setNotificationURL() atribui valor a tag "<URLNotificacao>" no XML Moip, respons�vel por definir a URL ao qual o Moip dever� notificar com o NASP (Notifica��o de Altera��o de Status de Pagamento) as mudan�a de status.

setNotificationURL($url)

$url : String

$moip->setNotificationURL('https://meusite.com.br/nasp/');

addComission()

O m�todo addComission() atribui valores as tags "<Comissoes>" no XML Moip, respons�vel por atribuir recebedores secund�rios a transa��o.

1. $reason : Raz�o/Motivo ao qual o recebedor secund�rio receber� o valor definido.
2. $receiver: Login Moip do usuario que receber� o valor.
3. $value : Valor ao qual ser� destinado ao recebedor secund�rio.
4. $percentageValue: Caso "true" define que valor ser� calculado em rela��o ao percentual sobre o valor total da transa��o.
5. $ratePayer: Caso "true" define que esse recebedor secund�rio ir� pagar a Taxa Moip com o valor recebido.

addComission($reason, $receiver, $value, $percentageValue, $ratePayer)

$reason : String

$receiver : String

$value : Number

$percentageValue: Boolean

$ratePayer : Boolean

addParcel()

O m�todo addParcel() atribui valores as tags de "<Parcelamentos>" no XML Moip, respons�vel configuras as op��es de parcelamento que ser�o disponíveis ao pagador.

1. $min : Quantidade mínima de parcelas disponível ao pagador.
2. $max : Quantidade m�xima de parcelas disponíveis ao pagador.
3. $rate : Valor de juros a.m por parcela.
4. $transfer : Caso "true" define que o valor de juros padr�o do Moip ser� pago pelo pagador.

addParcel($min, $max, $rate, $transfer)

$min : Number

$max : Number

$rate : Number

$transfer : Boolean

$moip->addParcel('2', '4');
$moip->addParcel('5', '7', '1.00');
$moip->addParcel('8', '12', null, true);

setReceiver()

O m�todo setReceiver() atribui valor a tag "<LoginMoIP>" do node "<Recebedor>" que identifica o usu�rio Moip que ir� receber o pagamento no Moip.

1. $receiver : Login Moip do recebedor primario.

setReceiver($receiver)

$receiver : String

$moip->setReceiver('[email protected]');

getXML()

O m�todo getXML() ir� retornar o XML gerado com todos os atributos que voc� configurou, esse m�todo pode ajudar a saber exatamente o XML que voc� ir� enviar ao Moip.

getXML()

send()

O m�todo send() executa o envio da instru��o ao Moip, e retorna os dados de resposta obtidos do Moip.

1. response : "true" para o caso de sucesso e "false" para quando ocorre algum erro.
2. error : Retorna sempre uma mensagem quando "response" � "false".
3. xml: Retorna sempre o XML de resposta Moip quando "response" � "true".

send()

getAnswer()

O m�todo getAnswer() retorna os dados de resposta do Moip em forma de objeto.

1. response : "true" para o caso onde o "<Status>" Moip retornou "Sucesso" e "false" para quando retornou "Falha".
2. error : Retorna sempre uma mensagem quando "response" � "false".
3. token: Retorna o TOKEN de pagamento gerado para quando "response" � "true".
4. payment_url : Retorna a URL de checkout Moip preparada para redirecionar o cliente com o TOKEN de pagamento para quando "response" � "true".

getAnswer()

queryParcel()

O m�todo queryParcel() retorna um Array() contendo as informa��es de parcelas e seus respectivos valores cobrados por parcela e o valor total a ser pago referente a taxa de juros simulada..

1. REQUEST
2. $login: Login Moip do usuario.
3. $maxParcel: M�ximo de parcelar a ser consultado.
4. $rate: Taxa de juros para simula��o.

5. $simulatedValue: Valor pago ao qual ser� simulado.

6. RESPONSE
7. response : "true" em caso de resposta Moip com "<Status>" "Sucesso" e "false" em caso de "Falha"
8. installment: Numero de parcela correspondente aos valores.
9. total : Total a ser pago.
10. rate: Taxa de juros atribuido.
11. value: Valor por parcela.

queryParcel($login, $maxParcel, $rate, $simulatedValue)

$login : String

$maxParcel : Number

$rate : Number

$simulatedValue: Number