HomeGuiaAPI ReferenceNovidadesComunidade
API Reference
These docs are for v1.0. Click to read the latest docs for v4.1.

Obtendo o código checkout

Usando a tela do PagSeguro

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Veja mais sobre as credenciais em Autenticação

string
required

Veja mais sobre as credenciais em Autenticação)

Body Params
string
required

Moeda utilizada. Indica a moeda na qual o pagamento será feito. No momento, a única opção disponível é BRL (Real).
Formato: Case sensitive. Somente o valor BRL é aceito.
x-www-form-urlencoded: currency

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.
x-www-form-urlencoded:itemId1, itemId2 etc.

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.
x-www-form-urlencoded:itemDescription1, itemDescription2 etc.

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.
x-www-form-urlencoded:itemAmount1, itemAmount2 etc.

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.
x-www-form-urlencoded:itemQuantity1, itemQuantity2 etc.

string
required

Pesos dos itens. Correspondem ao peso (em gramas) de cada item sendo pago. O PagSeguro usa o peso do item para realizar o cálculo do custo de frete nos Correios, exceto se o custo de frete do item já for especificado diretamente.
Formato: Um número inteiro correspondendo ao peso em gramas do item. A soma dos pesos de todos os produtos não pode ultrapassar 30000 gramas (30 kg).
x-www-form-urlencoded:itemWeight1, itemWeight2 etc.

string

Custos de frete dos itens. Representam os custos de frete de cada item sendo pago. Caso este custo seja especificado, o PagSeguro irá assumi-lo como o custo do frete do item e não fará nenhum cálculo usando o peso do item.
Formato: Decimal, com duas casas decimais separadas por ponto (p.e., 1234.56), maior que 0.00 e menor ou igual a 9999999.00.
x-www-form-urlencoded:itemShippingCost1, itemShippingCost2 etc.

string
required

Obrigatoriedade do endereço de entrega.

False: Não será solicitado ao comprador o endereço de entrega, recomendado para Checkouts que não possuem entrega física.

True: Solicita o endereço do comprador, mesmo que os parâmetros de shipping.address não forem passados.
x-www-form-urlencoded:shippingAddressRequired

string

Nome da rua do endereço de envio. Informa o nome da rua do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Livre, com limite de 80 caracteres.
x-www-form-urlencoded:shippingAddressStreet

string

Número do endereço de envio. Informa o número do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Livre, com limite de 20 caracteres.
x-www-form-urlencoded:shippingAddressNumber

string

Complemento do endereço de envio. Informa o complemento (bloco, apartamento, etc.) do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Livre, com limite de 40 caracteres.
x-www-form-urlencoded:shippingAddressComplement

string

Bairro do endereço de envio. Informa o bairro do endereço de envio do produto. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Livre, com limite de 60 caracteres.
x-www-form-urlencoded:shippingAddressDistrict

string

Cidade do endereço de envio. Informa a cidade do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Livre. Deve ser um nome válido de cidade do Brasil, com no mínimo 2 e no máximo 60 caracteres.
x-www-form-urlencoded:shippingAddressCity

string

Estado do endereço de envio. Informa o estado do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Duas letras, representando a sigla do estado brasileiro correspondente.
x-www-form-urlencoded:shippingAddressState

string

País do endereço de envio. Informa o país do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: No momento, apenas o valor BRA é permitido.
x-www-form-urlencoded:shippingAddressCountry

string

CEP do endereço de envio. Informa o CEP do endereço de envio do produto. Pode enviá-lo caso queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Um número de 8 dígitos
x-www-form-urlencoded:shippingAddressPostalCode

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.
x-www-form-urlencoded : shippingType

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.
x-www-form-urlencoded : shippingCost

string

Nome completo do comprador. Especifica o nome completo do comprador que está realizando o pagamento. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: No mínimo duas sequências de caracteres, com o limite total de 50 caracteres.
x-www-form-urlencoded : senderName

string

E-mail do comprador. Especifica o e-mail do comprador que está realizando o pagamento. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: um e-mail válido (p.e., [email protected]), com no máximo 60 caracteres.
x-www-form-urlencoded : senderEmail

string

DDD do comprador. Especifica o código de área (DDD) do comprador que está realizando o pagamento. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Um número de 2 dígitos correspondente a um DDD válido.
x-www-form-urlencoded : senderAreaCode

string

Número do telefone do comprador. Especifica o número do telefone do comprador que está realizando o pagamento. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Um número de 7 a 9 dígitos.
x-www-form-urlencoded : senderPhone

string

Tipo de documento do comprador. Especifica o tipo do documento é CPF ou CNPJ.
Formato:CPF ou CNPJ
x-www-form-urlencoded : senderCPF e senderCNPJ

string

Número do CPF ou CNPJ do comprador Especifica o CPF/CNPJ do comprador que está realizando o pagamento. Este campo é opcional e você pode enviá-lo caso já tenha capturado os dados do comprador em seu sistema e queira evitar que ele preencha esses dados novamente no PagSeguro.
Formato: Um número de 11 dígitos para CPF ou 14 dígitos para CNPJ.
x-www-form-urlencoded : senderCPF e senderCNPJ

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.
x-www-form-urlencoded : reference

string

URL de redirecionamento após o pagamento. Determina a URL para a qual o comprador será redirecionado após o final do fluxo de pagamento. Este parâmetro permite que seja informado um endereço de específico para cada pagamento realizado.
Formato: Uma URL válida, com limite de 255 caracteres.
x-www-form-urlencoded : redirectURL

string

Especifica o e-mail que deve aparecer na tela de pagamento.
Formato: um e-mail válido (p.e., [email protected]), com no máximo 60 caracteres. O e-mail informado deve estar vinculado à conta PagSeguro que está realizando a chamada à API.
x-www-form-urlencoded : receiverEmail

acceptedPaymentMethods: exclude
object
paymentMethodConfigs: paymentMethodConfig
object
string

Parâmetro utilizado para desabilitar a funcionalidade recuperação de carrinho.
Formato: Deve ser utilizado FALSE para desabilitar a recuperação de carrinho. Na ausência do parâmetro será utilizado o valor configurado na conta PagSeguro do cliente.
Obs: Caso a conta PagSeguro do cliente estiver com a opção recuperação de carrinho desabilitada, não será possível habilita-la através da API utilizando o valor TRUE.
x-www-form-urlencoded : enableRecover

string

Tempo de expiração do checkout. Com este parâmetro você poderá definir, no momento da chamada para o PagSeguro, qual o tempo máximo que o checkout ficará disponível para o cliente antes deste ser invalidado.
Formato: Tempo em minutos.
Obs: O tempo mínimo da duração do checkout é de 20 minutos e máximo de 100000 minutos.
x-www-form-urlencoded : timeout

string

Número máximo de usos para o código de pagamento. Determina o número máximo de vezes que o código de pagamento criado pela chamada à API de Pagamentos poderá ser usado. Este parâmetro pode ser usado como um controle de segurança.
Formato: Um número inteiro maior que 0 e menor ou igual a 999.
x-www-form-urlencoded : maxUses

string

Prazo de validade do código de pagamento. Determina o prazo (em segundos) durante o qual o código de pagamento criado pela chamada à API de Pagamentos poderá ser usado. Este parâmetro pode ser usado como um controle de segurança.
Formato: Um número inteiro maior ou igual a 30 e menor ou igual a 999999999.
x-www-form-urlencoded : maxAge

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.
x-www-form-urlencoded : extraAmount

Headers
string

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

Responses

Language
LoadingLoading…
Response
Choose an example:
application/xml

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001