These docs are for v1.0. Click to read the latest docs for v4.1.

Provider

Parâmetros

ParâmetroDescrição
v2/authorizations/request/?appId=appid&appKey=appkeySolicita autorização
/v2/authorization/request.jhtml?code=code_authorizationDireciona para autorização da aplicação
/v2/authorizations/notifications/NOTIFICATION_CODE?appId=appid&appKey=appkeyConsulta o notification code recebido quando o vendedor autoriza a aplicação

Parâmetros de autenticação

ParâmetroDescrição
appIdID da Aplicação.
Presença: Obrigatória.
Tipo: Texto.
Formato: Uma sequência de até 60 caracteres.
appKeyEspecifica o token correspondente à aplicação PagSeguro que está realizando a requisição. Presença: Obrigatória.
Tipo: Texto.
Formato: Uma sequência de 32 caracteres.

Parâmetros de requisição

Os parâmetros esperados pela API de Requisição são Case sensitive e estão
descritos na tabela abaixo:

PARÂMETRODESCRIÇÃO
Identificador usado para fazer referência à autorização da sua requisição.
Presença: Opcional.
Tipo: Texto.
Formato: Livre, com limite total de 20 caracteres.
Permissões a serem autorizadas
Presença: Obrigatória.
Tipo: Texto.
Valores aceitos:
CREATE_CHECKOUTS A aplicação poderá direcionar compradores para o PagSeguro e intermediar pagamentos
RECEIVE_TRANSACTION_NOTIFICATIONS A aplicação poderá receber e consultar notificações das transações que ela intermediou
SEARCH_TRANSACTIONS A aplicação poderá consultar as transações que ela intermediou
MANAGE_PAYMENT_PRE_APPROVALS A aplicação poderá gerenciar e utilizar pré-aprovações de pagamentos
DIRECT_PAYMENT A aplicação poderá gerenciar pagamentos via checkout transparente.
CANCEL_TRANSACTIONS A aplicação poderá solicitar cancelamento de transações
REFUND_TRANSACTIONS A aplicação poderá solicitar estorno de transações
URL para onde o comprador será redirecionado após a finalização do fluxo de autorização. Caso seja informado na chamada, será utilizada esta ao invés da URL informada no cadastro da aplicação.
Presença: Obrigatória.
Tipo: Texto.
Formato: Uma URL válida, com limite de 255 caracteres
URL para onde a notificação será direcionada após a finalização do fluxo de autorização. Caso seja informado na chamada, será utilizada esta ao invés da URL informada no cadastro da aplicação.
Presença: Opcional.
Tipo: Texto.
Formato: Uma URL válida, com limite de 255 caracteres.

Parâmetros de requisição

Os parâmetros abaixo ficam aninhados dentro da tag do XML.

PARÂMETRODESCRIÇÃO
<account>
Object
Este campo é a raiz do arquivo XML e engloba os dados do cadastro.
Presença: Opcional.
<email>
String
Conta a ser cadastrada
Presença: Opcional.
Tipo: Texto.
Formato: um e-mail válido (p.e., [email protected]), com no máximo 60 caracteres.
<type>
String
Tipo da conta.
Presença: Opcional.
Tipo: Texto.
Formato: Os tipos de contas são: Vendedor ou Empresarial
<person>
Object
Agrupa os dados de vendedor.
<name>
String
Nome completo do vendedor
Presença: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
<documents>
Object
Agrupa a informação de documento do vendedor.
<document>
String
Agrupa a informação de documento do vendedor.
Presença: Opcional (CPF).
<type>
String
Tipo do documento
Presença: Obrigatória, se informada a tag document.
Tipo: Texto.
Formato: O tipo documento permitido para o vendedor é somente CPF
<value>
String
CPF do vendedor
Presença: Obrigatória, se informada a tag document.
Tipo: Número.
Formato: Aceitará apenas números de CPF válidos e não restritos (no PagSeguro/UOL).
<birthDate>
Object
Data de nascimento do Vendedor
Presença: Opcional.
Tipo: Texto.
Formato: YYYY/MM/DD.
<phones>
Object
Agrupa as informações de telefone do vendedor.
<phone>
String
Agrupa as informações de telefone do vendedor.
Presença: Opcional.
<type>
String
Tipo de telefone
Presença : Obrigatória, se informada a tag phone.
Tipo: Texto.
Formato: Os tipos de telefone permitidos são HOME, MOBILE e BUSINESS.
<areaCode>
String
Código de área do telefone
Presença: Obrigatória, se informada a tag phone.
Tipo: Número.
Formato: Um número de 2 dígitos correspondente a um DDD válido.
<number>
String
Número do telefone
Presença: Obrigatória, se informada a tag phone.
Tipo: Número.
Formato: Aceita apenas números de 8 a 9 dígitos.
<company>
Object
Agrupa os dados de empresa
<displayName>
String
Nome completo da empresa
Presença: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
<documents>
Object
Agrupa as informações de documentos do responsável legal pela empresa e empresa
<document>
String
Agrupa as informações de documentos do responsável legal pela empresa e empresa
Presença: Opcional (CPF e CNPJ)
<type>
String
CNPJ da empresa
Presença: Obrigatória se informada a tag document.
Tipo: Número.
Formato: Aceitará apenas números de CNPJ válidos e não restritos (no PagSeguro/UOL).
<websiteURL>
Object
URL do website da empresa
Presença: Opcional.
Tipo: Texto.
Formato: Uma URL válida com no máximo 256 caracteres.
<partner>
Object
Agrupa os dados do responsável legal pela empresa.
<name>
String
Nome do responsável legal pela empresa
Presença: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
<documents>
Object
CPF do vendedor
Presença: Obrigatória se informada a tag document.
Tipo: Número.
Formato: Quando o type for CPF aceitará apenas número de CPF válido e não restrito (no PagSeguro/UOL).
<birthDate>
Object
Data de nascimento do Vendedor
Presença: Opcional.
Tipo: Texto.
Formato: DD/MM/AAAA.
<address>
Object
Agrupa os dados de endereço do vendedor ou empresa.
Presença: Opcional.
<postalCode>
String
CEP do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Número.
Formato: Um número de 8 dígitos correspondente a um CEP válido.
<street>
String
Nome da rua do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto com números, letras (sem acento), espaços e os caracteres “.” (ponto) e “-“ hífen, com no máximo 80 caracteres.
O valor deste campo só será cadastrado quando CEP informado não tiver nome de rua associado.
<number>
String
Número do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto livre com no máximo 20 caracteres.
<complement>
String
Complemento do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto com números, letras (sem acento), espaços e os caracteres “.” (ponto) e “-“ hífen, com no máximo 40 caracteres.
<district>
String
Bairro do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto com números, letras (sem acento), espaços e os caracteres “.” (ponto) e “-“ hífen, com no máximo 60 caracteres. O valor deste campo só será cadastrado quando CEP informado não tiver bairro associado.
<city>
String
Cidade do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto livre. Será cadastrada a cidade associada ao CEP informado.
<state>Estado do endereço do vendedor ou da empresa.
Presença: Opcional.
Tipo: Texto.
Formato: Texto livre. Será cadastrado o estado associado ao CEP informado.
<country>
String
Código ISO do país do endereço do vendedor ou da empresa
Presença: Opcional.
Tipo: Texto.
Formato: de 2 a 10 números, letras e o caractere “-“ (hífen).