---
updatedAt: 2026-08-26T16:35:24.000Z
agentTools:
projectIndex: https://developer.pagbank.com.br/v1.0/llms.txt
---
# Boleto
Checkout Transparente
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "pscore-produção",
"version": "1.0"
},
"servers": [
{
"url": "https://ws.pagseguro.uol.com.br"
}
],
"security": [
{}
],
"paths": {
"/v2/transactions/?": {
"post": {
"summary": "Boleto",
"description": "Checkout Transparente",
"operationId": "transparente-boleto",
"parameters": [
{
"name": "email",
"in": "query",
"description": "Veja mais sobre as credenciais em [Autenticação](#autenticacao)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "query",
"description": "Veja mais sobre as credenciais em [Autenticação](#autenticacao)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "x-www-form-urlencoded:
`application/x-www-form-urlencoded; charset=ISO-8859-1`
XML:
`application/xml; charset=ISO-8859-1`",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"payment",
"mode",
"method",
"currency",
"sender",
"sender: hash",
"sender: name",
"sender: email",
"sender: phone",
"phone: areaCode",
"phone: number",
"documents",
"documents: type",
"documents: value",
"items",
"item",
"item: id",
"item: description",
"item: amount",
"item: quantity",
"shipping",
"shipping: addressRequired"
],
"properties": {
"payment": {
"type": "object",
"description": "**Nó principal, onde terá todos os dados de pagamento**",
"properties": {}
},
"mode": {
"type": "string",
"description": "**Modo de pagamento.**
**Formato:** aceita a opção 'default'.
"
},
"method": {
"type": "string",
"description": "**Meio de pagamento.**
**Formato:** `boleto`.
"
},
"currency": {
"type": "string",
"description": "**Moeda utilizada.** Indica a moeda na qual o pagamento será feito. No momento, a única opção disponível é BRL (Real)."
},
"sender": {
"type": "object",
"description": "**Dados do comprador**",
"properties": {}
},
"sender: hash": {
"type": "string",
"description": "**Identificador do vendedor** (fingerprint) gerado pelo JavaScript do PagSeguro.
**Formato:** Obtido a partir de uma chamada javascript PagseguroDirectPayment.onSenderHashReady()."
},
"sender: name": {
"type": "string",
"description": "**Nome completo do comprador.** Especifica o nome completo do comprador que está realizando o pagamento.
**Formato:** No mínimo duas sequências de caracteres, com o limite total de 50 caracteres.
"
},
"sender: email": {
"type": "string",
"description": "**E-mail do comprador.** Especifica o e-mail do comprador que está realizando o pagamento.
**Formato:** Um e-mail válido (p.e., usuario@site.com.br), com no máximo 60 caracteres.
"
},
"sender: phone": {
"type": "object",
"description": "**Dados do telefone do comprador**",
"properties": {}
},
"phone: areaCode": {
"type": "string",
"description": "**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": {
"type": "string",
"description": "**Número do telefone do comprador.** Especifica o número do telefone do comprador que está realizando o pagamento.
**Formato:** Um número de 7 a 9 dígitos.
"
},
"documents": {
"type": "object",
"description": "**Dados de documentos do comprador**",
"properties": {}
},
"documents: type": {
"type": "string",
"description": "**Tipo de documento do comprador.** Especifica o tipo do documento é CPF ou CNPJ.
**Formato:**`CPF` ou `CNPJ`
"
},
"documents: value": {
"type": "string",
"description": "**Número do CPF ou CNPJ do comprador** Especifica o CPF/CNPJ do comprador que está realizando o pagamento.
"
},
"items": {
"type": "object",
"description": "**Lista de itens contidos na transação. O número de itens sob este elemento corresponde ao valor de itemCount.**",
"properties": {}
},
"item": {
"type": "object",
"description": "**Dados de cada item**",
"properties": {}
},
"item: id": {
"type": "string",
"description": "**Identificadores dos itens.** Identificam os itens sendo pagos. Você pode escolher códigos que tenham significado para seu sistema e informá-los nestes parâmetros. O PagSeguro não realiza qualquer validação sobre esses identificadores, mas eles não podem se repetir em um mesmo pagamento.
**Formato:** Livre, com limite de 100 caracteres.
"
},
"item: description": {
"type": "string",
"description": "**Descrições dos itens.** Descrevem os itens sendo pagos. A descrição é o texto que o PagSeguro mostra associado a cada item quando o comprador está finalizando o pagamento, portanto é importante que ela seja clara e explicativa.
**Formato:** Livre, com limite de 100 caracteres.
"
},
"item: amount": {
"type": "string",
"description": "**Valores unitários dos itens.** Representam os preços unitários de cada item sendo pago. Além de poder conter vários itens, o pagamento também pode conter várias unidades do mesmo item. Este parâmetro representa o valor de uma unidade do item, que será multiplicado pela quantidade para obter o valor total dentro do pagamento.
**Formato:** Decimal, com duas casas decimais separadas por ponto (p.e., 1234.56), maior que 0.00 e menor ou igual a 9999999.00.
"
},
"item: quantity": {
"type": "string",
"description": "**Quantidades dos itens.** Representam as quantidades de cada item sendo pago. Além de poder conter vários itens, o pagamento também pode conter várias unidades do mesmo item. Este parâmetro representa a quantidade de um item, que será multiplicado pelo valor unitário para obter o valor total dentro do pagamento.
**Formato:** Um número inteiro maior ou igual a 1 e menor ou igual a 999.
"
},
"shipping": {
"type": "object",
"description": "**Dados do frete**",
"properties": {}
},
"shipping: addressRequired": {
"type": "string",
"description": "**Obrigatoriedade do endereço de entrega. **
**Formato:**
**True**: Os parâmetros de `shipping.address` deverão ser passados
**False:** os parâmetros de `shipping.address` não deverão ser passados.
"
},
"address: street": {
"type": "string",
"description": "**Nome da rua do endereço de envio.** Informa o nome da rua do endereço de envio do produto.
**Formato:** Livre, com limite de 120 caracteres.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: number": {
"type": "string",
"description": "**Número do endereço de envio.** Informa o número do endereço de envio do produto.
**Formato:** Livre, com limite de 20 caracteres.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: district": {
"type": "string",
"description": "**Bairro do endereço de envio.** Informa o bairro do endereço de envio do produto.
**Formato:** Livre, com limite de 60 caracteres.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: city": {
"type": "string",
"description": "**Cidade do endereço de envio.** Informa a cidade do endereço de envio do produto.
**Formato:** Livre. Deve ser um nome válido de cidade do Brasil, com no mínimo 2 e no máximo 60 caracteres.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: state": {
"type": "string",
"description": "**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.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: country": {
"type": "string",
"description": "**País do endereço de envio.** Informa o país do endereço de envio do produto.
**Formato:** No momento, apenas o valor BRA é permitido.
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: postalCode": {
"type": "string",
"description": "**CEP do endereço de envio.** Informa o CEP do endereço de envio do produto.
**Formato:** Um número de 8 dígitos
**Obrigátorio:** Se o `addressRequired` estiver como `true`.
"
},
"address: complement": {
"type": "string",
"description": "**Complemento do endereço de envio.** Informa o complemento (bloco, apartamento, etc.) do endereço de envio do produto.
**Formato:** Livre, com limite de 40 caracteres.
"
},
"shipping: type": {
"type": "integer",
"description": "**Tipo de frete.** Informa o tipo de frete a ser usado para o envio do produto. Esta informação é usada pelo PagSeguro para calcular, junto aos Correios, o valor do frete a partir do peso dos itens. Os valores aceitos e seus significados são: 1 - Encomenda normal (PAC), 2 - SEDEX, 3 - Tipo de frete não especificado.
**Formato:** Um número inteiro entre 1 e 3.
",
"format": "int32"
},
"shipping: cost": {
"type": "string",
"description": "**Valor total do frete.** Informa o valor total de frete do pedido. Caso este valor seja especificado, o PagSeguro irá assumi-lo como valor do frete e não fará nenhum cálculo referente aos pesos e valores de entrega dos itens.
**Formato:** Decimal, com duas casas decimais separadas por ponto (p.e., 1234.56), maior que 0.00 e menor ou igual a 9999999.00.
"
},
"reference": {
"type": "string",
"description": "**Código de referência.** Define um código para fazer referência ao pagamento. Este código fica associado à transação criada pelo pagamento e é útil para vincular as transações do PagSeguro às vendas registradas no seu sistema.
**Formato:** Livre, com o limite de 200 caracteres.
"
},
"receiver: email": {
"type": "string",
"description": "**Especifica o e-mail do vendedor que vai receber o pagamento.**
**Formato:** Um e-mail válido, com limite de 60 caracteres. O e-mail informado deve estar vinculado à conta PagSeguro que está realizando a chamada à API.
"
},
"extraAmount": {
"type": "string",
"description": "**Valor extra.** Especifica um valor extra que deve ser adicionado ou subtraído ao valor total do pagamento. Esse valor pode representar uma taxa extra a ser cobrada no pagamento ou um desconto a ser concedido, caso o valor seja negativo.
**Formato:** Decimal (positivo ou negativo), com duas casas decimais separadas por ponto (p.e., 1234.56 ou -1234.56), maior ou igual a -9999999.00 e menor ou igual a 9999999.00. Quando negativo, este valor não pode ser maior ou igual à soma dos valores dos produtos.
"
},
"notificationURL": {
"type": "string",
"description": "**URL para envio de notificações.**
**Formato:** Uma URL válida, com limite de 255 caracteres.
"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/xml": {
"examples": {
"Ok": {
"value": "\n\n 2019-01-29T15:01:52.000-02:00\n 96B58137-065E-4669-B055-D12B2FB38E34\n R123456\n 1\n 1\n 2019-01-29T15:01:55.000-02:00\n \n 2\n 202\n \n https://sandbox.pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=b7989f954e7253974d2bf0bbe6c80cfb6caa0e146b13d70d90ffbb3243b22302c4600a923e6f02b0\n 2.00\n 0.00\n 0.48\n 1.52\n 0.00\n 1\n 1\n \n - \n 1\n Descricao do item a ser vendido\n 2\n 1.00\n
\n \n \n Fulano Silva\n fulano.silva@sandbox.pagseguro.com.br\n \n 11\n 30380000\n \n \n \n CPF\n 72962940005\n \n \n \n \n \n Av. Brigadeiro Faria Lima\n 1384\n 1 andar\n Jardim Paulistano\n Sao Paulo\n SP\n BRA\n 01452002\n \n 3\n 0.00\n \n "
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/xml": {
"examples": {
"Result": {
"value": "\n\n \n Error Code \n Error Description\n \n"
}
}
}
}
},
"401": {
"description": "401",
"content": {
"text/plain": {
"examples": {
"Result": {
"value": "Unauthorized"
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "html",
"code": "paymentMode=default\n&paymentMethod=boleto\n¤cy=BRL\n&extraAmount=0.00\n&itemId1=0001\n&itemDescription1=Notebook Prata\n&itemAmount1=24300.00\n&itemQuantity1=1\n¬ificationURL=https://sualoja.com.br/notifica.html\n&reference=REF1234\n&senderName=Jose Comprador\n&senderCPF=72962940005\n&senderAreaCode=11\n&senderPhone=56273440\n&senderEmail=comprador@uol.com.br\n&senderHash={{hash_do_comprador}}\n&shippingAddressRequired=true\n&shippingAddressStreet=Av. Brig. Faria Lima\n&shippingAddressNumber=1384\n&shippingAddressComplement=5o andar\n&shippingAddressDistrict=Jardim Paulistano\n&shippingAddressPostalCode=01452002\n&shippingAddressCity=Sao Paulo\n&shippingAddressState=SP\n&shippingAddressCountry=BRA\n&shippingType=1\n&shippingCost=1.00",
"name": "x-www-form-urlencoded"
},
{
"language": "xml",
"code": "\n default\n boleto\n \n Fulano Silva\n fulano.silva@sandbox.pagseguro.com.br\n \n 11\n 30380000\n \n \n \n CPF\n 72962940005\n \n \n {{hash_do_comprador}}\n \n BRL\n https://sualoja.com.br/notificacao\n \n - \n 1\n Descricao do item a ser vendido\n 2\n 1.00\n
\n \n0.00\n R123456\n\n\t\t\t\ttrue\n \n Av. Brigadeiro Faria Lima\n 1384\n 1 andar\n Jardim Paulistano\n Sao Paulo\n SP\n BRA\n 01452002\n \n 3\n 0.00\n \n",
"name": "XML"
},
{
"language": "curl",
"code": "curl -X POST \\\n 'https://ws.pagseguro.uol.com.br/v2/transactions/?email=email@email.com&token=token' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'paymentMethod=boleto&paymentMode=default¤cy=BRL&extraAmount=1.00&itemId1=0001&itemDescription1=Notebook%20Prata&itemAmount1=24300.00&itemQuantity1=1¬ificationURL=https%3A%2F%2Fsualoja.com.br%2Fnotifica.html&reference=REF1234&senderName=Jose%20Comprador&senderCPF=22111944785&senderAreaCode=11&senderPhone=56273440&senderEmail=comprador%40sandbox.pagseguro.com.br&senderHash=d7987e16cc89269cc2c0fb50288b383fdb5193b9aa94edac54de2cf624e80e88&shippingAddressStreet=Av.%20Brig.%20Faria%20Lima&shippingAddressNumber=1384&shippingAddressComplement=5o%20andar&shippingAddressDistrict=Jardim%20Paulistano&shippingAddressPostalCode=01452002&shippingAddressCity=Sao%20Paulo&shippingAddressState=SP&shippingAddressCountry=BRA&undefined='",
"name": "cURL"
}
],
"samples-languages": [
"html",
"xml",
"curl"
]
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": false,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```