| Chamadas | Descrição |
|---|---|
| recurring-payment/boletos | Gerar boleto |
Parâmetros
Detalhes dos parâmetros para geração dos boletos:
| Campo | Descrição |
|---|---|
reference | Campo destinado a controles internos do vendedor. Tamanho máximo: 200 caracteres. Este parâmetro é opcional. |
firstDueDate | Formato: aaaa-mm-dd Data de vencimento para qual será gerado o primeiro boleto - permitido 1 dia à partir da data presente até D+30. Se o parâmetro numberOfPayments > 1, os próximos vencimentos seguirão com a mesma data informada no na data dd nos períodos subsequentes. Para meses onde não existirem a data informada, será considerado sempre um dia anterior. |
numberOfPayments | Informar a quantidade de boletos a serem gerados para cada comprador. À partir da primeira data de vencimento informada no campo firstDueDate, será gerada a quantidade de boletos informados neste campo, com vencimentos para os períodos subsequentes. Exemplo: firstDueDate: 2017-10-20numberOfPayments: 4periodicity: monthlyBoletos gerados: 1. Vencimento em: 20/10/2017 2. Vencimento em: 20/11/2017 3. Vencimento em: 20/12/2017 4. Vencimento em: 20/01/2018 Permitido preencher de 1 a 12. |
periodicity | Frequência na qual os boletos serão gerados para cobrança. Necessário informar: monthlyAtualmente a chamada não aceita nenhum outro valor diferente. |
amount | Informar o valor em reais a ser cobrado em cada boleto. Mínimo 5.00 e máximo 1000000.00 Formato: decimal, com duas casas decimais separadas por ponto (ex: 1234.56) |
instructions | Campo instruções do boleto, personalizado para uso do vendedor, restrito a 100 caracteres. |
description | Descrição do produto objeto da cobrança. Campo alfanumérico detalhado no extrato PagSeguro do comprador. Tamanho máximo: 100. |
customer | Dados pessoais do comprador, descrito na tabela customer abaixo |
address | Dados de endereço do comprador, descritos na tabela address abaixo. Este parâmetro é opcional. |
notificationURL | URL para recebimento de notificação. Realiza validação de url válida. Tamanho máximo: 255. Este parâmetro é opcional. |
Dados pessoais e de endereço do comprador
Como estamos tratando de boletos registrados, os dados pessoais são obrigatórios.
Os dados de endereço são opcionais, porém a partir do momento que o elemento address é informado, todos os sub-parâmetros dele são obrigatórios.
Estes devem ser informados aninhados dentro dos parâmetros customer e address da tabela anterior.
Parâmetros do elemento customer
| Parâmetro | Sub-Parâmetro | Descrição |
|---|---|---|
document | type | Tipo do documento a ser informado, pode ser “CPF” ou “CNPJ” |
| value | Número do documento indicado no campo anterior. Formato: de 11 a 14 dígitos. | |
name | Nome completo ou Razão Social do comprador do produto /serviço referente ao boleto gerado. Formato: Campo alfanumérico livre, com no mínimo duas sequências de strings. Tamanho máximo: 50 caracteres. | |
phone | areaCode | DDD do comprador. Formato: Um número de 2 dígitos correspondente a um DDD válido (p.e., “11”) |
| number | Telefone do consumidor. Formato: Um número entre 8 e 9 dígitos sem traços ou pontos. | |
| Email do comprador |
Parâmetros do elemento address
| Parâmetro | Descrição |
|---|---|
postalCode | CEP sem traços ou pontos. Formato: Um número de 8 dígitos, p.e. 01046010. |
street | Nome da rua. Formato: Campo alfanumérico livre. Tamanho máximo: 160 caracteres. |
number | Número. Formato: Campo alfanumérico livre. Tamanho máximo: 20 caracteres. |
district | Bairro. Formato: Campo alfanumérico livre. Tamanho máximo: 60 caracteres |
complement | Complemento. Formato: Campo opcional alfanumérico livre. Tamanho máximo: 40 caracteres |
city | Cidade. Formato: Campo alfanumérico livre. Deve ser um nome válido de cidade do Brasil. Tamanho máximo: 60 caracteres. |
state | Estado. Formato: Duas letras, representando a sigla. |
{
"reference": "PEDIDO123",
"firstDueDate": "2017-09-14",
"numberOfPayments": "4",
"periodicity": "monthly",
"amount": "19.87",
"instructions": "juros de 1% ao dia e mora de 5,00",
"description": "Assinatura de Sorvete",
"customer": {
"document": {
"type": "CPF",
"value": "00000000000"
},
"name": "Alini QA",
"email": "compradoralini@xpto.com.br",
"phone": {
"areaCode": "11",
"number": "80804040"
},
"address": {
"postalCode": "01046010",
"street": "Av. Ipiranga",
"number": "100",
"district": "Republica",
"city": "Sao Paulo",
"state": "SP"
}
}
}
A API irá retornar o código da transação gerada no PagSeguro, a URL do boleto online, a linha digitável do código de barras e a data vencimento do boleto.
Com essas informações você pode optar por enviar os boletos online, imprimi-los, ou até mesmo incluir o código de barras no aplicativo de sua empresa.
Para consultar o status do pagamento das transações e outros dados, você deve integrar com integração com API de Notificações.
{
"boletos": [
{
"code": "6A91AC74-D6BB-45CB-BC04-A6EB855A131B",
"paymentLink": "https://pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=df0597592d53e1007805153628f83d667d52a67f15bed3e65f036d22602c3fe1f777c423b8409b2e",
"barcode": "03399557345480000000998765401025954420000030050",
"dueDate": "2017-09-14"
},
{
"code": "21331CF4-7470-48F0-AFC3-95F10C2A48E7",
"paymentLink": "https://pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=60ae9af4f314f9f4ddc5442cfd6b951bd1087ef363dc3aefbaa1f7e39dddb0f8696572d0f19ef49c",
"barcode": "03399557345480000000998765401025954420000030050",
"dueDate": "2017-10-14"
},
{
"code": "94AE93E6-C91F-495D-9B54-6E1A8F8CC684",
"paymentLink": "https://pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=273e997cf68be8a94fd332ba845321e6c8894b75eb930814494faf47e008e51f4b76c88f99dcd39e",
"barcode": "03399557345480000000998765401025954420000030050",
"dueDate": "2017-11-14"
},
{
"code": "8FC514FD-36CC-4A3E-8913-F3AFA37E2391",
"paymentLink": "https://pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=c1bf49771e9f017eede2158c819733f5606cd2cc2eb660d4d0bc70a2759da5f14b26d12a5db6cec1",
"barcode": "03399557345480000000998765401025954420000030050",
"dueDate": "2017-12-14"
}
]
}
Para emissão de 2ª via do boleto, é necessário que o vendedor acesse sua conta PagSeguro e:
- Acesse o Extrato de Transações.
- Localize a transação desejada e entre nos detalhes desta.
- Clique no link: Gerar 2ª via do boleto.
Se o boleto não estiver vencido, é possível reabrir o boleto já criado em formato PDF. Porém, se estiver vencido, um novo boleto será gerado com data de vencimento para 3 dias adiante.
Atenção:
Não é possível obter o número do código de barras por meio do painel.
Existe um prazo máximo para esta geração de boleto vencido. Ele pode ser configurado, juntamente com a data de vencimento de novo boleto e diferenciação ou não de dias úteis ou corridos. Consulte seu gestor comercial ou entre em contato com a Central de Relacionamento.
Gestão de Boletos
Para ter controle e fazer a gestão de seus boletos gerados, pagos e pendentes, é necessária a integração com API de Notificações.