Boleto

post https://ws.pagseguro.uol.com.br/v2/transactions/?

Checkout Transparente

Query Params

string

required

Veja mais sobre as credenciais em Autenticação

token

string

required

Veja mais sobre as credenciais em Autenticação

Body Params

mode

string

required

Modo de pagamento.
Formato: aceita a opção 'default'.

method

string

required

Meio de pagamento.
Formato: boleto.

currency

string

required

Moeda utilizada. Indica a moeda na qual o pagamento será feito. No momento, a única opção disponível é BRL (Real).

sender: hash

string

required

Identificador do vendedor (fingerprint) gerado pelo JavaScript do PagSeguro.
Formato: Obtido a partir de uma chamada javascript PagseguroDirectPayment.onSenderHashReady().

sender: name

string

required

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

string

required

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.

phone: areaCode

string

required

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

required

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

string

required

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

documents: value

string

required

Número do CPF ou CNPJ do comprador Especifica o CPF/CNPJ do comprador que está realizando o pagamento.

item: id

string

required

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

string

required

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

string

required

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

string

required

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: addressRequired

string

required

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

string

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

string

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

string

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

string

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

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.
Obrigátorio: Se o addressRequired estiver como true.

address: country

string

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

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
Obrigátorio: Se o addressRequired estiver como true.

address: complement

string

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

int32

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.

shipping: cost

string

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

string

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

string

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

string

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

string

URL para envio de notificações.
Formato: Uma URL válida, com limite de 255 caracteres.

Headers

Content-Type

string

x-www-form-urlencoded:
application/x-www-form-urlencoded; charset=ISO-8859-1
XML:
application/xml; charset=ISO-8859-1

Responses

Language

Request


xxxxxxxxxx
1
curl -X POST \
2
  'https://ws.pagseguro.uol.com.br/v2/transactions/?email=email@email.com&token=token' \
3
  -H 'Content-Type: application/x-www-form-urlencoded' \
4
  -d 'paymentMethod=boleto&paymentMode=default&currency=BRL&extraAmount=1.00&itemId1=0001&itemDescription1=Notebook%20Prata&itemAmount1=24300.00&itemQuantity1=1&notificationURL=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='

Choose an example:

application/xml

text/plain

200200

400400

401401