manual do desenvolvedor boleto bancário - userede.com.br · 1. boleto bancário mais uma das...

Manual do Desenvolvedor

Boleto Bancário

Março de 2013

Versão 1.0

Índice Página

1. Boleto Bancário ......................................................................... 1

2. Elementos da Solicitação ............................................................ 1 2.1 BoletoTxn ......................................................................... 1 2.2 Exemplo de XML:............................................................... 2

3. Elementos da Resposta .............................................................. 3

4. Elementos para Transação Query (consulta) ................................. 5 4.1 Elementos da Solicitação .................................................... 5 4.2 Elementos da Resposta ...................................................... 5 4.3 Exemplo de XML ................................................................ 5

5. Códigos de resposta específicos para Boleto .................................. 8

1. Boleto Bancário

Mais uma das opções de pagamento do e-Commerce Redecard é o Boleto bancário. Com ele o estabelecimento tem a opção de gerar os boletos para seus consumidores pela Plataforma. Para usar este serviço o cliente precisa ter contrato com seu banco para receber os créditos. A geração do Boleto é efetuada no e-Commerce e os repasses dos valores são diretamente com o Banco.

É possível utilizar este tipo de pagamento em conjunto com a funcionalidade HPS e HCC, bem como Fraude e Serviços de Risco.

A seguinte legenda será utilizada neste documento:

R - Obrigatório O - Opcional X – Excluir - preencher este campo pode causar a falha da transação

2. Elementos da Solicitação

O seguinte elemento complexo pode ser enviado na solicitação XML e será incluído no pedido de autorização da transação.

Request o Transaction

TxnDetails – consulte a Seção 2.2.1.3 da Referência dos

Desenvolvedores do e-Commerce Redecard

BoletoTxn– consulte a Seção 2.1

2.1 BoletoTxn

Nome do Elemento: BoletoTxn

Posição: Request.Transaction

Elementos da Solicitação do BoletoTxn

Nome do Elemento Descrição Valores/ Limitações

Obrigatório?

method Tipo de transação payment R

expiry_date Data de validade a ser atribuída ao Boleto que está sendo emitido. Pode ser de até 12 meses no futuro

AAAA-MM-DD R

language Idioma do cliente Tag de língua do IETF O

title Título/título honorífico do cliente

Por exemplo: Senhor, Senhora, Senhorita

O

first_name Primeiro nome do cliente Alfanumérico O

last_name O último nome / sobrenome do cliente

Alfanumérico O

billing_street1 O endereço de cobrança (primeira linha)

Alfanumérico O

billing_street2 O endereço de cobrança (segunda linha)

Alfanumérico O

billing_city A cidade de faturamento Alfanumérico O

billing_state_province O estado da cobrança doleto

Alfanumérico O

billing_postcode O código postal de cobrança

Alfanumérico O

billing_country O país de cobrança Alfanumérico O

customer_telephone Número de telefone do portador

O

customer_email Endereço de e-mail do cliente

64 caracteres no máximo, deve conter @ e.

O

customer_ip O endereço IPv4 do cliente nnn.nnn.nnn.nnn O

instructions O

interest_per_day O

overdue_fine O

processorID 11 = Itaú

12 = Bradesco

13 = Banco do Brasil

14 = HSBC

15 = Santander

16 = Caixa

2 dígitos numéricos O

2.2 Exemplo de XML:

Exemplo XML de Solicitação para bloco de dados BoletoTxn

<BoletoTxn>

<instructions>Here are some instructions</instructions>

<expiry_date>2013-04-01</expiry_date>

<customer_ip>192.168.0.1</customer_ip>

<method>payment</method>

<first_name>Joe</first_name>

<customer_email>[email protected]</customer_email>

<last_name>Schmoe</last_name>

<billing_street1>12 Abyford Road</billing_street1>

</BoletoTxn>

Exemplo XML de Solicitação Boleto

<Request version\='2'>

<Authentication>

<password>************</password>

<AcquirerCode>

<rdcd_pv>123456789</rdcd_pv>

</AcquirerCode>

</Authentication>

<Transaction>

<BoletoTxn>

<instructions>Here are some instructions</instructions>




<first_name>Joe</first_name>


<last_name>Schmoe</last_name>

<billing_street1>12 Abyford Road</billing_street1>

</BoletoTxn>

<TxnDetails>

<merchantreference>1006e46a5151d623a</merchantreference>

<amount currency="BRL">55.44</amount>

</TxnDetails>

</Transaction>

</Request>

3. Elementos da Resposta

A resposta do e-Commerce Redecard incluirá um resumo das informações apresentadas no pedido da transação, como método, linguagem, informações de clientes e dados específicos do boleto. Também incluirá informações necessárias pelo comerciante para suportar a emissão do Boleto para o cliente, ou reconciliar dados quando o Boleto tiver sido pago (através de uma transação de consulta).

Além dos elementos abordados nesta seção, as respostas para este serviço também contêm os elementos de Resposta gerais, conforme descritos na Seção 2.1.1.2 da Referência dos Desenvolvedores do e-Commerce Redecard.Erro! Fonte de referência não encontrada.

Importante: os elementos só vão aparecer na resposta se a informação estiver disponível

(por exemplo, o txn_paid_value não estará disponível ou mostrado se o txn_status

estiver pendente, ou seja, o Boleto ainda não foi pago.

Nome do Elemento: BoletoTxn

Posição: Response

Elementos de Resposta do BoletoTxn

Nome do Elemento Descrição Valores / Limitações

url

order_id

transaction_id

txn_status pendente

pago

txn_fine_value Qualquer multa paga através do Boleto

txn_total_due A quantia total devida sobre o Boleto, inclusive multas

txn_paid_value

Exemplo XML de Resposta para Boleto

<Response version="2">

<BoletoTxn>


<language>es</language>



<title>MR</title>

<first_name>JOHN</first_name>

<last_name>CAIXA</last_name>

<country>BR</country>

<billing_street1>Address Line 1</billing_street1>

<billing_city>JA</billing_city>

<billing_postcode>12345</billing_postcode>

<billing_country>BR</billing_country>

<customer_telephone>00000000000</customer_telephone>

<interest_per_day>0.1</interest_per_day>

<overdue_fine>0.05</overdue_fine>


<processor_id>11</processor_id>

<instructions>Não aceitar pagamento em cheques. Inadimplente -

Percentual Juros Dia: 10%. Percentual Multa: 5%.</instructions>

<url>http://www.domain.com/generatedurl456</url>

<order_id>7F000001:013829A1C09E:8DE9:016891F0</order_id>

<transaction_id>1418605</transaction_id>

<txn_status>PENDING</txn_status>

</BoletoTxn>

<gateway_reference>4200000027950077</gateway_reference>

<merchantreference>boleto1234</merchantreference>

<mode>LIVE</mode>

<reason>ACCEPTED</reason>

<status>1</status>

<time>1341312709</time>

</Response>

4. Elementos para Transação Query (consulta)

Uma transação query pode ser realizada para uma transação de Boleto da mesma forma

que uma transação com cartão. 4.1 Elementos da Solicitação

Request

o Authentication – consulte a Seção 2.1.1.1.1 da Referência dos

Desenvolvedores do e-Commerce RedecardErro! Fonte de referência não encontrada.

o Transaction

HistoricTxn – consulte a Seção 2.2.1.4 da Referência dos

Desenvolvedores do e-Commerce RedecardErro! Fonte de referência não encontrada.

4.2 Elementos da Resposta

A resposta do e-Commerce Redecard para uma informação de transação de Consulta pode variar, dependendo o status de pagamento do Boleto. Por exemplo, se o Boleto tiver

sido pago, o valor em txn_status será exibido como paid, e os campos detalhados

abaixo irão fornecer informações adicionais sobre o pagamento. Por favor consulte a Seção 3 para maiores detalhes sobre os campos disponíveis.3

4.3 Exemplo de XML

Exemplo XML de Solicitação para bloco de dados BoletoTxn

<Request version="2">

<Authentication>

<password>####</password>

<AcquirerCode>

<rdcd_pv>123456789</rdcd_pv>

</AcquirerCode>

</Authentication>

<Transaction>

<HistoricTxn>

<method>query</method>

<reference type="merchant">boleto1234</reference>

</HistoricTxn>

</Transaction>

</Request>

Exemplo de Resposta XML para payment_status = PENDING

<Response version='2'>

<QueryTxnResult>

<BoletoTxn>

<amount>100.00</amount>

<billing_city>SP</billing_city>


<billing_postcode>12949-110</billing_postcode>

<billing_street1>Av. Paulista 1111</billing_street1>

<boleto_number>536</boleto_number>

<boleto_url>https://testboletos.maxipago.net/redirection_service/boleto?r

ef=LmO9fsnOXyUgTcRusHkbMQFQxVkk9OBmXEK5CanaeV8JEVxxqROSI7%2Bawb9qrL8ZTSC4

pnEbe8iF%0AmHp1r%2FX7Vg%3D%3D</boleto_url>





<first_name>Daniel</first_name>

<instructions>Não aceitar pagamento em cheques. Percentual Juros

Dia: 1%. Percentual Multa: 1%.</instructions>


<last_name>Lucats</last_name>

<merchant_id>3701</merchant_id>

<order_id>536</order_id>


<payment_status>PENDING</payment_status>



</BoletoTxn>

<datacash_reference>3600900010035659</datacash_reference>

<merchantreference>Teste28061003</merchantreference>

<reason>Boleto Bancario payment pending</reason>

<status>1911</status>

</QueryTxnResult>

<mode>LIVE</mode>


<status>1</status>

<time>1372424737</time>

</Response>

Exemplo de Resposta XML para txn_payment = PAID

<?xml version="1.0" encoding="UTF-8"?>

<Response version='2'>

<QueryTxnResult>

<BoletoTxn>

<amount>350.00</amount>

<billing_city>SP</billing_city>


<billing_postcode>12949-110</billing_postcode>

<billing_street1>Av. Paulista 1111</billing_street1>

<boleto_number>175</boleto_number>

<boleto_url>https://testboletos.maxipago.net/redirection_service/boleto?r

ef=LmO9fsnOXyUgTcRusHkbMQFQxVkk9OBmXEK5CanaeV%2FHdhcaC70EcHH2dNlwmP53TSC4

pnEbe8iF%0AmHp1r%2FX7Vg%3D%3D</boleto_url>




<expected_amount>399</expected_amount>


<first_name>Daniel</first_name>

https://testboletos.maxipago.net/redirection_service/boleto?ref=LmO9fsnOXyUgTcRusHkbMQFQxVkk9OBmXEK5CanaeV8JEVxxqROSI7%2Bawb9qrL8ZTSC4pnEbe8iF%0AmHp1r%2FX7Vg%3D%3D%3c/boleto_url



mailto:[email protected]%3c/customer_email

https://testboletos.maxipago.net/redirection_service/boleto?ref=LmO9fsnOXyUgTcRusHkbMQFQxVkk9OBmXEK5CanaeV%2FHdhcaC70EcHH2dNlwmP53TSC4pnEbe8iF%0AmHp1r%2FX7Vg%3D%3D%3c/boleto_url



mailto:[email protected]%3c/customer_email

<instructions>Não aceitar pagamento em cheques. Percentual Juros

Dia: 1%. Percentual Multa: 1%.</instructions>


<last_name>Lucats</last_name>

<merchant_id>3701</merchant_id>

<order_id>175</order_id>


<paid_amount>350.00</paid_amount>

<payment_date>2013-04-14</payment_date>

<payment_status>PAID</payment_status>



</BoletoTxn>

<datacash_reference>3900900010002228</datacash_reference>

<merchantreference>Teste110458</merchantreference>


<status>1</status>

</QueryTxnResult>

<mode>LIVE</mode>


<status>1</status>

<time>1372425377</time>

</Response>

5. Códigos de resposta específicos para Boleto

Como parte da implementação, os seguintes códigos de resposta ‘Específicos do Boleto’ foram criados.

Código Motivo Descrição

1911 Payment pending

Uma transação válida de “pagamento” foi recebida, mas ainda não houve nenhuma “payment_notification”

1912 Not enabled for Boleto

Bancario

o estabelecimento comercial não pode utilizar o serviço Boleto Bancario

1913 Invalid value supplied Um campo contém um valor inválido

1914 Missing mandatory element Um ou mais elementos obrigatórios (vencimento, etc.) não foi fornecido

1915 Failure response received Falha na transação

1916 Communications Error Erro de comunicação

1917 Payment notification can only

be sent internally

A notificação de pagamento deve ser enviada com credenciais internas

1918

Payment notification attempted

against non-existent

transaction

Nenhuma transação de pagamento do Boleto Bancário correspondente encontrada

1919

Payment notification attempted

against an already-paid

transaction

A transação de pagamento correspondente do Boleto Bancário já foi paga

1920 Payment notification attempted

with a different vTID

A notificação de pagamento deve utilizar o mesmo vTID que a transação de pagamento do Boleto Bancario

manual do desenvolvedor boleto bancário - userede.com.br · 1. boleto bancário mais uma das...

Documents