Gerar Boleto

post https://ws.pagseguro.uol.com.br/recurring-payment/boletos?email={email}&token={token}

Query Params

string

required

Email cadastrado na conta de produção.

token

string

required

Token gerado na conta de produção.

Body Params

reference

string

Campo destinado a controles internos do vendedor.
Tamanho máximo: 200 caracteres.

firstDueDate

string

required

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 na data dd nos períodos subsequentes.
Para meses onde não existirem a data informada, será considerado sempre um dia anterior.

numberOfPayments

int32

required

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.
Permitido preencher de 1 a 12.

periodicity

string

required

Frequência na qual os boletos serão gerados para cobrança.
Necessário informar: monthly.
Atualmente a chamada não aceita nenhum outro valor diferente.

amount

string

required

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

string

Campo instruções do boleto, personalizado para uso do vendedor
Tamanho: restrito a 100 caracteres.

description

string

required

Descrição do produto objeto da cobrança.
Campo alfanumérico detalhado no extrato PagSeguro do comprador.
Tamanho máximo: 100.

document: type

string

required

Especifica o tipo do documento é CPF ou CNPJ.
Formato:CPF ou CNPJ

document: value

string

required

Especifica o CPF/CNPJ do comprador que está realizando o pagamento.
Formato: Um número de 11 dígitos para CPF ou 14 dígitos para CNPJ.

name

string

required

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

string

DDD do comprador. Especifica o código de área (DDD) do comprador que está realizando o pagamento.
Formato: Um número de 2 dígitos correspondente a um DDD válido.

phone: number

string

Número do telefone do comprador. Especifica o número do telefone do comprador que está realizando o pagamento.
Formato: Um número de 8 a 9 dígitos.

string

Email do comprador

address: postalCode

string

CEP do endereço de envio.
Informa o CEP do endereço de envio do produto.
Formato: Um número de 8 dígitos

address: street

string

Nome da rua do endereço de envio. Informa o nome da rua do endereço de envio do produto.
Formato: Campo alfanumérico livre com limite de 160 caracteres.

address: number

string

Número do endereço de envio. Informa o número do endereço de envio do produto.
Formato: Campo alfanumérico livre com limite de 20 caracteres.

address: district

string

Bairro do endereço de envio.
Informa o bairro do endereço de envio do produto.
Formato: Campo alfanumérico livre com limite de 60 caracteres.

address: complement

string

Complemento do endereço de envio. Informa o complemento (bloco, apartamento, etc.) do endereço de envio do produto.
Formato: Campo alfanumérico livre com limite de 40 caracteres.

address: city

string

Cidade do endereço de envio.
Informa a cidade do endereço de envio do produto.
Formato: Campo alfanumérico livre com limite de 60 caracteres, deve ser um nome válido de cidade do Brasil

address: state

string

Estado do endereço de envio.
Informa o estado do endereço de envio do produto.
Formato: Duas letras, representando a sigla do estado brasileiro correspondente.

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://ws.pagseguro.uol.com.br/recurring-payment/boletos?email=email&token=token' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200200

400400