raniellyferreira/moip-php

与MoIP集成的库

维护者

详细信息

github.com/raniellyferreira/moip-php

主页

源代码

安装: 11

依赖者: 0

建议者: 0

安全: 0

星级: 0

观察者: 3

分支: 68

dev-master 2015-09-11 19:42 UTC

Requires

  • php: >=5.3.3
  • ext-curl: *
  • lib-curl: *
  • lib-libxml: *
  • lib-openssl: *

MIT 9931f90cb976165899bd1535043e4eac4037cc91

This package is not auto-updated.

Last update: 2024-09-28 18:05:22 UTC

README

Moip-PHP是一个库，它实现了Moip指令XML的抽象层，允许您在API集成时不必在代码中插入多行XML。快速示例

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());

Moip-PHP使用Fluent Interfaces标准，因此您可以使用以下方式实现上面的示例

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());

可用方法

以下列出并详细说明了您可以使用Moip-PHP的可用方法。

Moip()

构造方法。

Moip()

$moip = new Moip();

setEnvironment()

定义请求将处理的环境的方法，'test'表示将使用Moip的测试环境Sandbox，省略此方法表示请求将在生产环境Moip中处理。

重要：在定义环境时，请确保您正在使用对应环境的认证，在Moip中，每个环境都有自己的API认证密钥。

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

$moip->setEnvironment('test');

setCredential()

Moip要求您进行认证才能处理API请求，为此，在进行任何请求之前，您必须向Moip提供您的API凭证，这些凭证由TOKEN和KEY组成。

$credencials参数是一个关联数组，包含key和token键（例如：array('key'=>'sua_key','token'=>'seu_token')）。如果您还没有这些数据，请查看如何通过您的Sandbox账户获取它们。

setCredential($credential)

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

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

validate()

validate()方法将验证您要处理类型指令所需的数据，您可以选择两种验证级别之一：'Basic'和'Identification'。

  1. Basic：将验证向Moip发送XML请求所需的最小数据。
  2. Identification：将验证处理带Moip标识的XML所需的数据，通常用于在Moip结账页面的第二步中重定向客户或使用Moip透明支付。

validate($validateType)

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

$moip->validate('Identification');

setUniqueID()

setUniqueID()方法为Moip XML中的"<IdProprio>"标签分配值。

  1. <IdProprio>：您的唯一订单标识符，此信息将随我们的状态变更通知发送给您，以便您识别订单并处理其状态。

setUniqueID($id)

$id : String

$moip->setUniqueID('ABCD123456789');

setValue()

setValue()方法为Moip XML中的"<Valor>"标签分配值。

  1. <Valor>：负责定义应支付的价值。

setValue($value)

$value : Numeric

$moip->setValue('100.00');

setAdds()

setAdds()方法为Moip XML中的"<Acrescimo>"标签分配值。

  1. <Acrescimo>：负责定义应支付的增加值。

setAdds($value)

$value : Numeric

$moip->setAdds('15.00');

setDeduct()

setDeduct()方法为Moip XML中的"<Deducao>"标签分配值。

  1. <Deducao>：负责定义从应付款总额中扣除的折扣金额。

setDeduct($value)

$value : Numeric

$moip->setDeduct('15.00');

setReason()

setReason()方法为Moip XML中的"<Razao>"标签分配值。

  1. <Razao>：负责定义付款原因。
  2. 此字段在付款指令中始终是必填项。

setReason($value)

$value : String

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

setPayer()

方法setPayer()用于向XML Moip中的"<Pagador>"节点分配值。

  1. <Pagador>：表示进行支付的人的信息节点。
  2. name : <Nome>：支付者的全名
  3. email : <Email>：支付者的电子邮件
  4. payerId : <IdPagador>：支付者的唯一标识符
  5. identity : <Identidade>：支付者的身份（CPF）
  6. phone : <TelefoneCelular>：支付者的次要联系电话
  7. billingAddress : <EnderecoCobranca>：支付者的地址
  8. address : <Logradouro>：支付者的街道、大道、道路等
  9. number : <Numero>：支付者的住宅号码
  10. complement : <Complemento>：支付者地址的补充信息
  11. city : <Cidade>：支付者地址的城市
  12. neighborhood : <Bairro>：支付者地址的街区
  13. state : <Estado>：支付者地址的州，按照ISO-CODE格式（UF）
  14. country : <Pais>：支付者的国家，按照ISO-CODE格式
  15. zipCode : <CEP>：地址的CEP
  16. phone : <TelefoneFixo>：支付者的联系电话

setPayer($value)

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

$moip->setPayer(array('name' => 'Nome Sobrenome',
    	'email' => 'email@cliente.com.br',
    	'payerId' => 'id_usuario',
        'billingAddress' => array('address' => 'Rua do Zézinho Coração',
        		'number' => '45',
        		'complement' => 'z',
        		'city' => 'São Paulo',
        		'neighborhood' => 'Palhaço Jão',
        		'state' => 'SP',
        		'country' => 'BRA',
        		'zipCode' => '01230-000',
        		'phone' => '(11)8888-8888')));

addPaymentWay()

方法addPaymentWay()用于向XML Moip中的"<FormasPagamento>"节点的"<FormaPagamento>"标签分配值。

<FormaPagamento>：定义在Moip结账页面向支付者显示的支付方式。

  1. billet：在Moip结账中提供"银行汇票"作为支付方式。
  2. financing：在Moip结账中提供"分期付款"作为支付方式。
  3. debit：在Moip结账中提供"账户借记"作为支付方式。
  4. creditCard：在Moip结账中提供"信用卡"作为支付方式。
  5. debitCard：在Moip结账中提供"借记卡"作为支付方式。

addPaymentWay($way)

$way : 字符串 ('billet','financing','debit','creditCard','debitCard')

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

setBilletConf()

方法setBilletConf()用于向XML Moip中的"<Boleto>"节点分配值，该节点负责定义银行汇票的额外配置和个人化。

  1. $expiration : 格式为"AAAA-MM-DD"的日期或天数。
  2. $workingDays：如果"$expiration"是天数，您可以使用"true"来指定是否按工作日计算，默认为连续天数。
  3. $instructions：要打印在汇票上的附加消息，最多三条消息。
  4. $uriLogo：您的标志URL，最大宽度75px，高度40px。

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

$expiration : 整数或日期

$workingDays : 布尔值

$instructions : 数组

$uriLogo : 字符串

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

addMessage()

方法addMessage()用于向XML Moip中的"<Mensagens>"节点的"<Mensagem>"标签分配值。

  1. <Mensagens>：包含"<Mensagens>"的节点。
  2. <Mensagem>：定义在Moip结账页面显示的附加消息的标签。

addMessage($msg)

$msg : 字符串

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

setReturnURL()

方法setReturnURL()用于向XML Moip中的"<URLRetorno>"标签分配值，该标签负责定义在通过Moip结账完成支付后买家将被重定向的URL。

setReturnURL($url)

$url : 字符串

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

setNotificationURL()

方法setNotificationURL()用于向XML Moip中的"<URLNotificacao>"标签分配值，该标签负责定义Moip将通知的URL，通知包括支付状态的变更（NASP）。

setNotificationURL($url)

$url : 字符串

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

addComission()

方法addComission()用于向XML Moip中的"<Comissoes>"标签分配值，该标签负责为交易分配次要接收者。

  1. $reason : 次要接收者将收到的金额的理由/原因。
  2. 接收者: 登录Moip的用户，将接收金额。
  3. $value : 将分配给次级接收者的金额。
  4. $percentageValue: 如果为"true"，则表示金额将根据交易总金额的百分比计算。
  5. $ratePayer: 如果为"true"，则表示此次级接收者将使用收到的金额支付Moip的手续费。

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

$reason : 字符串

$receiver : 字符串

$value : 数字

$percentageValue: 布尔值

$ratePayer : 布尔值

$moip->addComission('Razão do Split',
		'recebedor_secundario',
		'5.00');
$moip->addComission('Razão do Split',
		'recebedor_secundario_2',
		'12.00',
		true,
		true);

addParcel()

addParcel()方法将值分配给XML Moip中的"<Parcelamentos>"标签，该标签负责配置付款人可用的分期付款选项。

  1. $min : 付款人可用的最小分期数。
  2. $max : 付款人可用的最大分期数。
  3. $rate : 每期利息金额。
  4. $transfer : 如果为"true"，则表示Moip的标准利息金额将由付款人支付。

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

$min : 数字

$max : 数字

$rate : 数字

$transfer : 布尔值

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

setReceiver()

setReceiver()方法将值分配给"<Recebedor>"节点的"<LoginMoIP>"标签，该标签标识将接收Moip付款的Moip用户。

  1. $receiver : 次级接收者的Moip登录名。

setReceiver($receiver)

$receiver : 字符串

$moip->setReceiver('integracao@labs.moip.com.br');

getXML()

getXML()方法将返回包含您已配置的所有属性的XML，该方法可以帮助您确切地知道将要发送给Moip的XML。

getXML()

$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->getXML());

    //IRÃ? IMPRIMIR
    <?xml version="1.0" encoding="utf-8"?>
    <EnviarInstrucao>
        <InstrucaoUnica>
            <IdProprio></IdProprio>
            <Razao>Teste do Moip-PHP</Razao>
            <Valores>
                <Valor moeda="BRL">100.00</Valor>
            </Valores>
        </InstrucaoUnica>
    </EnviarInstrucao>

send()

send()方法执行将指令发送到Moip，并返回从Moip获得的响应数据。

  1. response : 如果成功则为"true"，如果发生错误则为"false"。
  2. error : 当"response"为"false"时，总是返回一个消息。
  3. xml: 当"response"为"true"时，总是返回Moip的响应XML。

send()

$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());

    //IRÃ? IMPRIMIR
    stdClass Object
    (
        [response] => 1
        [error] =>
        [xml] => <ns1:EnviarInstrucaoUnicaResponse xmlns:ns1="http://www.moip.com.br/ws/alpha/"><Resposta><ID>201209042007216380000000989104</ID><Status>Sucesso</Status><Token>M2C031R2Q0Z9W0Y4Q2S0H0W7E2G1Z6P3E8C0C0W050T01070Y9Y8V9G1F0F4</Token></Resposta></ns1:EnviarInstrucaoUnicaResponse>
    )

getAnswer()

getAnswer()方法以对象形式返回Moip的响应数据。

  1. response : 如果Moip的"<Status>"返回"成功"则为"true"，如果返回"失败"则为"false"。
  2. error : 当"response"为"false"时，总是返回一个消息。
  3. token: 当"response"为"true"时，返回生成的支付TOKEN。
  4. payment_url : 当"response"为"true"时，返回准备好的Moip结账URL，用于将客户重定向到带有支付TOKEN的结账页面。

getAnswer()

$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');
$moip->send();

print_r($moip->getAnswer());

//IRÃ? IMPRIMIR
stdClass Object
(
    [response] => 1
    [error] =>
    [token] => 92D091R2I0Y9X0E4T2K034L2H2V4H2J6L9R0S0T0K0N0L0T0Y9H879H144O8
    [payment_url] => https://desenvolvedor.moip.com.br/sandbox/Instrucao.do?token=92D091R2I0Y9X0E4T2K034L2H2V4H2J6L9R0S0T0K0N0L0T0Y9H879H144O8
)

queryParcel()

queryParcel()方法返回一个数组，其中包含分期付款信息以及每期的收取金额和根据模拟利息计算的应付款总额。

  1. REQUEST

  2. $login: 用户的Moip登录名。

  3. $maxParcel: 要查询的最大分期数。

  4. $rate: 模拟的利息率。

  5. $simulatedValue: 模拟支付的金额。

  6. RESPONSE

  7. response : 如果Moip的响应包含"<Status>" "成功"，则为"true"；如果为"失败"，则为"false"。

  8. installment: 与值对应的分期数。

  9. total : 总应付款额。

  10. rate: 分配的利息率。

  11. value: 每期金额。

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

$login : 字符串

$maxParcel : 数字

$rate : 数字

$simulatedValue: 数字

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


    print_r($moip->queryParcel('integracao@labs.moip.com.br', '4', '1.99', '100.00'));


    //IRÃ? IMPRIMIR
    Array
    (
        [response] => 1
        [installment] => Array
            (
                [1] => Array
                    (
                        [total] => 100.00
                        [rate] => 1.99
                        [value] => 100.00
                    )


                [2] => Array
                    (
                        [total] => 103.00
                        [rate] => 1.99
                        [value] => 51.50
                    )


                [3] => Array
                    (
                        [total] => 104.01
                        [rate] => 1.99
                        [value] => 34.67
                    )


                [4] => Array
                    (
                        [total] => 105.04
                        [rate] => 1.99
                        [value] => 26.26
                    )


            )


    )