{"info":{"_postman_id":"e66d24f3-8ec8-48a5-8f55-16005e359a67","name":"PagSeguro APIs","description":"

Esta documentação descreve o ecossistema de APIs oferecido pelo PagSeguro e contém todos os endpoints disponíveis para uso público.

Usando o Postman

A utilização do Postman como ferramenta de documentação serve a dois propósitos, o primeiro de declarar a função de cada API, bem como o comportamento esperado de cada uma delas e o segundo, de oferecer uma forma fácil e rápida para clientes e desenvolvedores testarem as nossas ferramentas sem depender de escrever ou conhecer código.

Ambientes

Essa documentação aponta por padrão para o nosso ambiente de sandbox, o que significa que, para utilizá-lo você precisará de um usuário neste ambiente, bem como suas chaves de autenticação.

Nas chamadas de API, o ambiente sendo utilizado é determinado pela URL.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Ambiente	URL
Sandbox	https://sandbox.api.pagseguro.com
Produção	https://api.pagseguro.com

Versão

As requests nas APIs de Charge devem ser acompanhadas da versão pertinente. A última versão da Charge, que está documentada aqui é a 4.0.\nPara espeficicar a versão na chamada, o header deve conter o parâmetro x-api-version = 4.0.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Usando o Postman","slug":"usando-o-postman"}],"owner":"10863174","collectionId":"e66d24f3-8ec8-48a5-8f55-16005e359a67","publishedId":"TVetc6HV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-27T21:22:55.000Z"},"item":[{"name":"Connect","item":[{"name":"Aplicação","item":[{"name":"Criar uma aplicação","id":"2a98d49e-025a-4e35-aeb0-f13d7c6dfe87","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/oauth2/application","description":"

Através desse recurso é feita a criação da sua aplicação, para que você possa realizar ações em nome dos usuários.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`name`	String (1 - 50 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Nome que vai aparecer na tela de permissões. Por exemplo:\"`Name` gostaria de sua permissão para acessar[...]\".
`description`	String (1 - 140 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Descrição da sua plataforma.
`site`	String (5 - 100 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Seu site
`redirect_uri`	String (5 - 100 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	O usuário será direcionado para essa URL após a aprovação das permissões, essa URL também será responsável por receber o `authorization code` que pode ser trocado pelo `acess_token`. Para o fluxo de authorization o envio da URL é necessário.
`client_id`	String (36 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Identificador exclusivo fornecido para sua aplicação.
`client_secret`	String (36 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Chave privada da sua aplicação.
`logo`	String (5 - 100 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Logo do seu negócio, ela deve ser enviada caso estiver utilizando o fluxo de `authorization_code`. Critérios do arquivo: Máx 1Mbytes; Formatos: JPG, PNG, SV; Tamanho mínimo: 220x80; Tamanho ideal ou máximo: 440x160.
`account_id`	String	`REQUEST: Não` `RESPONSE: Sim`	Código identificador da sua conta.
`client_type`	String	`REQUEST: Não` `RESPONSE: Sim`	Tipo da aplicação que está sendo criada.

Erros

Em caso de alguma condição não atendida os erros retornados pela API deixarão claro o que aconteceu. A seguir temos a seguinte lista de erros:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código	Descrição	Cenário
41001	`invalid_request`	Parâmetro não enviado, com um valor inválido ou com caracteres superiores ao permitido.
41002	`invalid_redirect_uri`	Parâmetro não enviado ou com um valor inválido.
41003	`invalid_client`	Falha na identificação do cliente.
41004	`invalid_grant`	Parâmetro com um valor inválido, expirado, que já foi usado ou que não pertence a você.
41005	`unsupported_grant_type`	Parâmetro com um valor diferente de `authorization_code` e `refresh_token`.
41006	`unauthorized_client`	Quando você não está autorizado a fazer essa ação.
41008	`invalid_token`	Parâmetro com um valor inválido ou inexistente passado no header da requisição.

","urlObject":{"path":["oauth2","application"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"56e810d9-dd48-4411-bb9d-bc81c1f5883f","name":"Sucesso ao criar uma aplicação no PagSeguro","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"App Name\",\r\n \"description\":\"Descrição da platforma\",\r\n \"site\":\"http://www.parceiro.com.br\",\r\n \"redirect_uri\":\"http://www.parceiro.com.br/retorno\",\r\n \"logo\":\"https://www.parceiro.com/static/media/logo.d2ebaf8f.svg\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/application"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \n \"client_id\":\"s6BhdRkqt3\",\n \"site\":\"http://www.parceiro.com.br\",\n \"description\":\"Descrição da platforma\",\n \"name\":\"App Name\",\n \"client_secret\":\"4eC39HqLyjWDarjtT1zdp7dc\",\n \"redirect_uri\":\"http://www.parceiro.com.br/retorno\",\n \"logo\":\"https://www.parceiro.com/static/media/logo.d2ebaf8f.svg\",\n \"account_id\": \"ACCO_737348328392729\",\n \"client_type\": \"confidential\"\n}"},{"id":"7dcd11f0-665e-4860-a416-5a7d38ae8480","name":"Erro ao criar uma aplicação no PagSeguro","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"App Name\",\n \"description\": \"Descrição da platforma\",\n \"site\": \"http://www.parceiro.com.br\",\n \"redirectUri\": \"http://www.parceiro.com.br/retorno\",\n \"logo\":\"https://www.parceiro.com/static/media/logo.d2ebaf8f.svg\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/application"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": 41001,\n \"description\": \"invalid_request\",\n \"parameter_name\": \"site\"\n },\n {\n \"code\": 41002,\n \"description\": \"invalid_redirect_uri\",\n \"parameter_name\": \"redirectUri\"\n\n }\n ]\n}"}],"_postman_id":"2a98d49e-025a-4e35-aeb0-f13d7c6dfe87"},{"name":"Consultar uma aplicação","id":"f1b2f68c-1a34-46fd-b074-365758d735f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"}],"url":"{{url}}/oauth2/application/{{client_id}}","description":"

Através desse recurso é possível fazer a consulta da sua aplicação que foi criada.

\n","urlObject":{"path":["oauth2","application","{{client_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2009b594-0917-4f8b-8691-aa8e2662a9cb","name":"Consultar uma aplicação - Sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"}],"url":"{{url}}/oauth2/application/{{client_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"client_id\": \"s6BhdRkqt3\",\n \"site\": \"http://www.parceiro.com.br\",\n \"description\": \"Descrição da platforma\",\n \"name\": \"App Name\",\n \"redirect_uri\": \"http://www.parceiro.com.br/retorno\",\n \"logo\":\"https://www.parceiro.com/static/media/logo.d2ebaf8f.svg\",\n \"account_id\": \"ACCO_737348328392729\"\n}"}],"_postman_id":"f1b2f68c-1a34-46fd-b074-365758d735f0"}],"id":"ced430b1-f718-43cb-89d1-3274b980e47e","description":"

Recomendamos que não compartilhe os dados da sua aplicação, elas são confidenciais.

\n","_postman_id":"ced430b1-f718-43cb-89d1-3274b980e47e"},{"name":"Connect Authorization","item":[{"name":"Solicitar a permissão para uma aplicação OAuth","id":"85847723-074e-4276-9f34-1c1235c19023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://connect.pagseguro.uol.com.br/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&state=xyz&scope=scope.name1+scope.name2","description":"

Esse recurso permite solicitar a autorização do usuário para sua aplicação

Atenção

Para que você possa pedir a permissão dos usuários você deve montar a URL com os dados que foi fornecido na criação da aplicação e os scopes de acesso.
Exemplo de como a URL deve ser montada:

https://connect.pagseguro.uol.com.br/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&scope=scope.name1+scope.name2&state=xyz

Instruções para utilizar Sandbox

A URL de Sandbox deve ser montada da seguinte forma:
https://connect.sandbox.pagseguro.uol.com.br/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&scope=scope.name1+scope.name2&state=xyz
Para passar pela tela de login é necessário usar os vendedores teste:

Para obter o Vendedor Teste é preciso se logar com sua conta no Sandbox;
Dentro do Menu PERFIS DE INTEGRAÇÃO acessar Aplicação;
Utilizar e-mail e senha do Vendedor de Testes.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`client_id`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Identificador único fornecido no momento da criação da sua aplicação.
`response_type`	String (ENUM)	`REQUEST: Sim` `RESPONSE: Não`	Define o tipo de resposta a ser obtido , `code`.
`redirect_uri`	String (5 - 150 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	URL para o redirecionamento de resposta d autorização após a permissão do usuário, ela DEVE ser a mesma de quando foi criada a Aplicação.
`scope`	String (150 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Nessa Tabela de escopos você encontra a lista de scopes disponíveis.
`code`	String (32 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Código de autorização que você pode trocar por um `access_token`. O código só pode ser usado uma única vez e tem a válidade de 10 min.
`state`	Alfanumérico (128 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Campo para ser passado as informações necessárias da sua autorização, podendo ser usado para controle de quem está dando a autorização.

A autorização é feita em três passos:

O usuário é redirecionado para a pagina de solicitação de permissões
Nesse momento é feita a autenticação do usuário, sendo assim o usuário se loga no PagSeguro, e ele visualiza os acessos que ele está fornecendo e tem a opção de aprovar ou negar.
Caso o usuário forneça as permissões, ele será redirecionado para a redirect_uri com o code relacionado a aprovação.

Erros

Em caso de alguma condição não atendida, os erros retornados pela API deixarão claro o que aconteceu. A seguir, temos a seguinte lista de erros:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Erro	Cenário
`invalid_request`	Parâmetro obrigatório não enviado ou algum parâmetro está com um valor inválido
`access_denied`	Autorização negada pelo usuário
`invalid_scope`	O escopo solicitado é inválido
`invalid_redirect_uri`	O parâmetro fornecido não corresponde ao registrado
`unsupported_response_type`	Parâmetro não suportado

","urlObject":{"protocol":"https","path":["oauth2","authorize"],"host":["connect","pagseguro","uol","com","br"],"query":[{"key":"response_type","value":"code"},{"key":"client_id","value":"partner_client_id"},{"key":"redirect_uri","value":"partner_callback_url"},{"key":"state","value":"xyz"},{"key":"scope","value":"scope.name1+scope.name2"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"58e517c9-e419-4427-b436-2a36efc8755b","name":"Sucesso ao solicitar permissão para uma aplicação OAuth","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://connect.pagseguro.com/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&scope=scope.name&state=xyz","protocol":"https","host":["connect","pagseguro","com"],"path":["oauth2","authorize"],"query":[{"key":"response_type","value":"code"},{"key":"client_id","value":"partner_client_id"},{"key":"redirect_uri","value":"partner_callback_url"},{"key":"scope","value":"scope.name"},{"key":"state","value":"xyz"},{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"http://www.partner.com.br/retorno?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz"},{"id":"4b11e92f-bb29-4114-af61-f6edf3594bb6","name":"Error ao solicitar permissão para uma aplicação OAuth","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://connect.pagseguro.com/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&scope=scope.name&state=xyz","protocol":"https","host":["connect","pagseguro","com"],"path":["oauth2","authorize"],"query":[{"key":"response_type","value":"code"},{"key":"client_id","value":"partner_client_id"},{"key":"redirect_uri","value":"partner_callback_url"},{"key":"scope","value":"scope.name"},{"key":"state","value":"xyz"},{"key":"","value":null,"disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"http://www.partner.com.br/retorno?error=access_denied&state=xyz"}],"_postman_id":"85847723-074e-4276-9f34-1c1235c19023"},{"name":"Trocar um authorization code por um access token","id":"923f0074-4a87-4a76-85cd-d82968b052f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer TOKEN"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X_CLIENT_ID","type":"text","value":"s6BhdRkqt3"},{"key":"X_CLIENT_SECRET","type":"text","value":"4eC39HqLyjWDarjtT1zdp7dc"}],"body":{"mode":"raw","raw":"{\n\t\"grant_type\": \"authorization_code\",\n\t\"code\": \"czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3\",\n\t\"redirect_uri\": \"http://www.parceiro.com.br/retorno\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/token","description":"

Esse recurso permite fazer a troca do code por um access_token quando o usuário conceder a permissão, com isso será possível realizar requisições em nome do usuário.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`Authorization`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Token gerado na área logada do cliente PagSeguro
`X_CLIENT_ID`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Identificador único fornecido no momento da criação da app.
`X_CLIENT_SECRET`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Chave privada enviada na criação do aplicação.
`grant_type`	String (ENUM)	`REQUEST: Sim` `RESPONSE: Não`	Tipo de solicitação desejada `authorization_code`.
`code`	String (32 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Código que foi enviado para URL no momento da permissão usuário.
`redirect_uri`	String (5 - 150 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	URL de redirecionamento do cliente, deve ser a mesma do momento da permissão.
`access_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token de acesso e autenticação.
`token_type`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Sempre terá um valor de `bearer`.
`expires_in`	Int (10 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Tempo de validade do `access_token` .
`refresh_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token para atualizar o `access_token` que foi obtido no processo de autorização.
`scope`	String	`REQUEST: Não` `RESPONSE: Sim`	Permissões que foram concedidas.
`account_id`	String	`REQUEST: Não` `RESPONSE: Sim`	Código identificador da conta do usuário que deu a autorização.

\n
\n\n

Importante
Além do Access Token do usuário que foi vinculado, você receberá o Refresh Token que deve ser utilizado para renovar suas credenciais periodicamente. O Access Token possui uma validade de 12 meses, é necessário fazer a renovação dele para continuar realizando as ações normalmente.

\n","urlObject":{"path":["oauth2","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ce733998-1f8f-4d5f-a600-2e188a99ccbc","name":"Sucesso ao trocar um authorization code por um access token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X_CLIENT_ID","type":"text","value":"s6BhdRkqt3"},{"key":"X_CLIENT_SECRET","type":"text","value":"4eC39HqLyjWDarjtT1zdp7dc"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"authorization_code\",\n \"code\": \"czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3\",\n \"redirect_uri\": \"http://www.parceiro.com.br/retorno\",\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"bearer\",\n \"access_token\": \"2YotnFZFEjr1zCsicMWpAA\",\n \"expires_in\": \"xxxxxx\",\n \"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\",\n \"scope\": \"scope.name\",\n \"account_id\": \"ACCO_737348328392943\"\n}"},{"id":"21e6b68e-f8f5-498d-815c-165687a7b338","name":"Error ao trocar um authorization code por um access token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X_CLIENT_ID","type":"text","value":"s6BhdRkqt3"},{"key":"X_CLIENT_SECRET","type":"text","value":"4eC39HqLyjWDarjtT1zdp7dc"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"authorization_code\",\n \"code\": \"czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3\",\n \"redirect_uri\": \"http://www.parceiro.com.br/retorno\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": 41001,\n \"description\": \"invalid_request\",\n \"parameter_name\": \"redirect_uri\"\n },\n {\n \"code\": 41004,\n \"description\":\"invalid_grant\",\n \"parameter_name\": \"code\"\n\n }\n ]\n}"}],"_postman_id":"923f0074-4a87-4a76-85cd-d82968b052f1"}],"id":"9f091ec7-e340-4a0d-950a-d03f8437125d","description":"

Para solicitar autorização, direcione o usuário para a pagina do PagSeguro passando as informações necessárias, como client_id, response_type, redirect_uri, scope.
\n
Caso o usuário tenha uma conta PagSeguro, serão apresentados os campos para que ele possa efetuar o login e assim visualizar as permissões que serão dadas.
\n
Se o usuário autorizou as permissões, ele será redirecionado para a redirect_uri com o code relacionado a aprovação.
\n
Para obter o token de autorização, faça a troca do code pelo access_token.
\n

Atenção

Caso o usuário mude o e-mail que ele usou para autorizar sua aplicação dentro do PagSeguro, será necessário realizar uma nova autorização com o e-mail novo.

Escopos disponíveis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Descrição
`payments.read`	Permissão para visualizar pedidos e cobranças.
`payments.create`	Permissão para criar e visualizar pedidos e cobranças.
`payments.refund`	Permissão para fazer reembolso.
`accounts.read`	Permissão para consultar os dados de cadastro do vendedor.

","_postman_id":"9f091ec7-e340-4a0d-950a-d03f8437125d"},{"name":"Connect SMS","item":[{"name":"Solicitar autorização via SMS","id":"b2951120-5d04-4118-8ce6-e3228209de86","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms","description":"

Utilize este endpoint para iniciar o seu processo de solicitação do access token do vendedor.

Instruções para utilização em sandbox:

Utilize e-mails com o sufixo @sandbox.pagseguro.com.br para simular o fluxo de sucesso.
Por exemplo: teste1@sandbox.pagseguro.com.br
Utilize o sufixo @blocked.pagseguro.com.br para simular o fluxo de erro: Vendedor bloqueado por excesso de envio de SMS.
Utilize o sufixo @unreachable.pagseguro.com.br para simular o fluxo de erro: Impossível enviar SMS para o telefone referente ao e-mail informado.
\nObs: Não há limite para as quantidades de e-mail que poderão ser utilizadas em sandbox. Porém, o resultado será sempre simulado.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`X_CLIENT_ID`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Código de cadastro do parceiro. Existente apenas para parceiros comerciais do PagSeguro
`X_CLIENT_SECRET`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Código de validação do parceiro comercial do PagSeguro
`Authorization`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Token gerado na área logada do cliente PagSeguro
`Content-Type`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Indica qual a interpretação correta do conteúdo, valor fixo: application/json
`email`	String	`REQUEST: SIM` `RESPONSE: SIM`	E-mail do cliente PagSeguro que deseja conceder permissão para o parceiro efetuar ações em nome dele na plataforma PagSeguro

","urlObject":{"path":["oauth2","authorize","sms"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9ff70254-7388-4bc0-9753-362375bb22dc","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"phone_number\": \"(11) *****-2741\",\r\n \"retry_after_seconds\": 251\r\n}"},{"id":"424fb585-48b0-4136-ba24-014e4eab4979","name":"Erro - Vendedor bloqueado por excesso de envio de SMS","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error_messages\": [\r\n {\r\n \"code\": \"USER_TEMPORARILY_BLOCKED\",\r\n \"description\": \"User temporarily blocked for SMS interactions. Try again later\"\r\n }\r\n ]\r\n}"},{"id":"a115b1cf-715c-43c5-9d78-9954aa9dc31f","name":"Erro - E-mail inválido para solicitar access token","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"MERCHANT_ACCOUNT_REQUIRED\",\n \"description\": \"Merchant account required\"\n }\n ]\n}"},{"id":"0d4defe9-5b8e-4f9f-98b2-bda43c84a42e","name":"Erro - Impossível enviar SMS para o telefone referente ao e-mail informado","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"UNREACHABLE_PHONE\",\n \"description\": \"Unable to contact account phone number. Merchant have to contact PagSeguro\"\n }\n ]\n}"},{"id":"8b55d7ad-5931-4b58-9471-b1ec24be1831","name":"Erro - Credenciais do parceiro invalidas","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"email@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/authorize/sms"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"INVALID_CREDENTIAL\",\n \"description\": \"Invalid credentials. Review AUTHORIZATION, X_CLIENT_ID and X_CLIENT_SECRET headers\"\n }\n ]\n}"}],"_postman_id":"b2951120-5d04-4118-8ce6-e3228209de86"},{"name":"Confirmar autorização com código SMS","id":"18833b57-1405-49d5-900d-c02be7128996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"sms\",\r\n\t\"email\": \"email@email.com\",\r\n\t\"sms_code\": \"000111\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/token","description":"

Utilize este endpoint para submeter o código informado pelo PagSeguro ao vendedor, para confirmar a sua solicitação.

Instruções para utilização em sandbox:
\nUtilize os códigos SMS abaixo para simular o fluxo de confirmação nos cenários abaixo:

123456 - cenário de sucesso (obtem access token para o e-mail utilizado na solicitação de autorização)
200200 - cenário de erro: Bloqueio por excesso de tentativas SMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`X_CLIENT_ID`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Código de cadastro do parceiro. Existente apenas para parceiros comerciais do PagSeguro
`X_CLIENT_SECRET`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Código de validação do parceiro comercial do PagSeguro
`Authorization`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Token gerado na área logada do cliente PagSeguro
`Content-Type`	String	`REQUEST: SIM` `RESPONSE: NÃO`	indica qual a interpretação correta do conteúdo, valor fixo: application/json
`email`	String	`REQUEST: SIM` `RESPONSE: NÃO`	E-mail do cliente PagSeguro que deseja conceder permissão para o parceiro efetuar ações em nome dele na plataforma PagSeguro
`grant_type`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Indica o tipo de autenticação usada, valor fixo: \"connect_sms\"
`code`	Integer	`REQUEST: SIM` `RESPONSE: NÃO`	Código SMS enviado para o número cadastrado na base PagSeguro
`access_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token de acesso
`token_type`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Sempre terá um valor de `bearer`.
`expires_in`	Int (10 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Tempo de validade do `access_token` .
`refresh_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token para atualizar o token de autenticação.
`scope`	String	`REQUEST: Não` `RESPONSE: Sim`	Permissões que foram concedidas.
`account_id`	String	`REQUEST: Não` `RESPONSE: Sim`	Código de identificador do vendedor.

","urlObject":{"path":["oauth2","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"40a0a666-cffc-49c1-bec4-eae6e3b5cdc4","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"sms\",\r\n\t\"email\": \"email@email.com\",\r\n\t\"sms_code\": \"000111\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pagseguro.com/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"bearer\",\n \"access_token\": \"2YotnFZFEjr1zCsicMWpAA\",\n \"expires_in\": \"xxxxxx\",\n \"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\",\n \"scope\": \"scope.name\",\n \"account_id\" : \"{{account_id}}\"\n}"},{"id":"9a89766a-00a6-4638-8cb6-1e17fe1e4780","name":"Erro - Bloqueio por excesso de tentativas SMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"sms\",\r\n\t\"email\": \"email@email.com\",\r\n\t\"sms_code\": \"000111\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pagseguro.com/oauth2/token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"USER_TEMPORARILY_BLOCKED\",\n \"description\": \"User temporarily blocked for SMS interactions. Try again later\"\n }\n ]\n}"},{"id":"2a4f4eb7-eca8-4ad4-b88c-31724c80180b","name":"Erro - SMS Token invalido ou expirado","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X_CLIENT_ID","value":"{{clientId}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{clientSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"sms\",\r\n\t\"email\": \"email@email.com\",\r\n\t\"sms_code\": \"000183\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pagseguro.com/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"INVALID_SMS_CODE\",\n \"description\": \"Invalid SMS code\",\n \"parameter_name\": \"sms_code\"\n }\n ]\n}"}],"_postman_id":"18833b57-1405-49d5-900d-c02be7128996"}],"id":"85c88849-1a6e-49fc-9dad-53adec18b433","description":"

Para solicitar autorização de forma transparente (sem redirecionar o vendedor para o ambiente do PagSeguro) é necessário informar o email do vendedor.
\n
Será enviado um sms de confirmação para o telefone cadastrado pelo vendedor no PagSeguro.
\n
O vendedor deve informar o código recebido através do parceiro para autorizar a obtenção do access_token.
\n
O access token obtido para um determinado vendedor, poderá ser utilizado ao chamar as nossas api's de cobrança: Order e Charge.
\n

Atenção: Para solicitar a autorização, o vendedor deve estar previamente cadastrado dentro do PagSeguro

O Diagrama ilustra como obter um Access token de um Vendedor

$\"N|Solid\"$

\n","_postman_id":"85c88849-1a6e-49fc-9dad-53adec18b433"},{"name":"Renovar um access token","id":"919f8674-daef-4a17-81a1-a8065fd5fa3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X_CLIENT_ID","type":"text","value":"s6BhdRkqt3"},{"key":"X_CLIENT_SECRET","type":"text","value":"4eC39HqLyjWDarjtT1zdp7dc"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\": \"refresh_token\",\r\n\t\"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}"},"url":"{{url}}/oauth2/refresh","description":"

Esse recurso permite fazer a atualização do acess token, sendo assim você troca de um Refresh Token por um Acess Token.\n
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`Authorization`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Token gerado na área logada do cliente PagSeguro
`X_CLIENT_ID`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Identificador único fornecido no momento da criação do app.
`X_CLIENT_SECRET`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Chave privada do app, enviado na criação do aplicação.
`grant_type`	String (ENUM)	`REQUEST: Sim` `RESPONSE: Não`	Tipo de solicitação desejada `refresh_token`.
`refresh_token`	String (100 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Token para atualizar o `access_token`.
`token_type`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Sempre terá um valor de `bearer`.
`access_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token de acesso e autenticação.
`expires_in`	Int (10 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Tempo de validade do `access_token` .
`scope`	String	`REQUEST: Não` `RESPONSE: Sim`	Permissões que foram concedidas.
`account_id`	String	`REQUEST: Não` `RESPONSE: Sim`	Código identificador da conta do usuário que deu a autorização.

\n
\n\n

Dica\n
\nVocê pode fazer uma chamada para atualizar o token antes de chamar um serviço para executar ações em nome do usuário.

\n","urlObject":{"path":["oauth2","refresh"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c5527dd0-44d1-4f8f-9566-94b3e67ff917","name":"Sucesso ao renovar um access token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"X_CLIENT_ID","value":"s6BhdRkqt3","type":"text"},{"key":"X_CLIENT_SECRET","value":"4eC39HqLyjWDarjtT1zdp7dc","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\": \"refresh_token\",\r\n\t\"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"token_type\": \"bearer\",\r\n \"access_token\": \"2YotnFZFEjr1zCsicMWpAA\",\r\n \"expires_in\": \"xxxxxx\",\r\n \"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\",\r\n \"scope\": \"scope.name\",\r\n \"account_id\": \"ACCO_737348328392943\"\r\n}"},{"id":"c001aa09-40b4-4011-9905-7dca04c5ba8b","name":"Error ao renovar um access token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"X_CLIENT_ID","value":"s6BhdRkqt3","type":"text"},{"key":"X_CLIENT_SECRET","value":"4eC39HqLyjWDarjtT1zdp7dc","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\": \"refresh_token\",\r\n\t\"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/refresh"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": 41003,\n \"description\": \"invalid_client\",\n \"parameter_name\": \"client_id\"\n },\n {\n \"code\": 41004,\n \"description\": \"invalid_grant\",\n \"parameter_name\": \"refresh_token\"\n }\n ]\n}\n"}],"_postman_id":"919f8674-daef-4a17-81a1-a8065fd5fa3a"},{"name":"Revogar um access token","id":"afb024e5-c3c9-4344-8451-9f43dabb2f83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer TOKEN"},{"key":"X_CLIENT_ID","type":"text","value":"s6BhdRkqt3"},{"key":"X_CLIENT_SECRET","type":"text","value":"4eC39HqLyjWDarjtT1zdp7dc"}],"body":{"mode":"raw","raw":"{\r\n\t\"token_type_hint\": \"access_token\",\r\n\t\"token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}"},"url":"{{url}}/oauth2/revoke","description":"

Esse recurso permite você revogar o acesso a conta de um usuário.\n
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`Authorization`	String	`REQUEST: SIM` `RESPONSE: NÃO`	Token gerado na área logada do cliente PagSeguro
`X_CLIENT_ID`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Identificador único fornecido no momento da criação do app.
`X_CLIENT_SECRET`	String (36 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Chave privada do app, enviado na criação do aplicação.
`token_type_hint`	String (ENUM)	`REQUEST: Sim` `RESPONSE: Não`	Tipo de token que está sendo enviado, podendo ser `access_token` ou `refresh_token` .
`token`	String (100 caracteres)	`REQUEST: Sim` `RESPONSE: Não`	Token correspondente ao `token_type`, que será utilizado para fazer a revogação.

\n
","urlObject":{"path":["oauth2","revoke"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dad9c1f2-b856-40d7-9eb9-626b5bd41c6f","name":"Sucesso revogar um acess token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"X-CLIENT_ID","value":"s6BhdRkqt3","type":"text"},{"key":"X_CLIENT_SECRET","value":"4eC39HqLyjWDarjtT1zdp7dc","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token_type_hint\": \"access_token\",\r\n\t\"token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/revoke"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"},{"id":"bbae06ea-28a6-4c5e-893b-88cd0808c71a","name":"Error ao revogar um acess token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer TOKEN","type":"text"},{"key":"X-CLIENT_ID","value":"s6BhdRkqt3","type":"text"},{"key":"X_CLIENT_SECRET","value":"4eC39HqLyjWDarjtT1zdp7dc","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"token_type_hint\": \"access_token\",\r\n \"token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth2/revoke"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": 41007,\n \"description\": \"invalid_request\",\n \"parameter_name\": \"token_type\"\n },\n {\n \"code\": 41003,\n \"description\": \"invalid_client\",\n \"parameter_name\": \"client_id\"\n }\n ]\n}"}],"_postman_id":"afb024e5-c3c9-4344-8451-9f43dabb2f83"}],"id":"dcd4ad47-15ab-45d4-bf47-4a11c83b6d30","description":"

Esta documentação se refere ao processo de conectar sua aplicação, seja ela E-commerce, Marketplace, conciliadores e etc. que precisam fazer ações em nome dos usuários PagSeguro. Para isso, você registra a sua aplicação no PagSeguro, conecta com as contas dos usuários caso eles já possuam uma conta aberta.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Ambiente	URL
Sandbox	https://sandbox.api.pagseguro.com
Produção	https://api.pagseguro.com

Gerar token do ambiente de teste:

Para obter o token de sandbox, acesse nossa página de Sandbox.
Após realizar o Login, Localize o menu Perfis de Integração e clique em Vendedor. O token de sandbox estará disponível na seção Credenciais.

Gerar token do ambiente de produção:

Para obter o token de produção acesse sua conta atráves do iBanking.
Após realizar o login, localize Vendas Online e clique em integrações.
Clique em Gerar token, você receberá o token pelo e-mail.

1. Criar sua aplicação

Para começar, crie uma aplicação para receber as credenciais que serão necessárias para fazer as chamadas das APIs

2. Solicitar a autorização e obter um access token

Nesta etapa, você pode solicitar a autorização e obtenção de um access token da seguintes formas:

Connect Authorization
Connect SMS

3. Trocar um refresh token por um access token

Para fazer a renovação do access token utilize o refresh token.

4. Revogar um access token

As permissões que foram dadas pelos usuários podem ser revogadas a qualquer momento.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ec914ac2-0e77-4e3b-8685-b031f28e6541"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9cad6db9-9f58-464f-b4c9-c41c95246461"}}],"_postman_id":"dcd4ad47-15ab-45d4-bf47-4a11c83b6d30"},{"name":"Accounts","item":[{"name":"Objeto Account","event":[{"listen":"test","script":{"id":"6c01bf9b-1399-46db-94ed-23541bb337f7","exec":["pm.test(\"Object Example - Method is not valid\", function () {"," pm.response.to.have.status(403);","});","","// Essa chamada, caso executada, deverá retornar um 403 Forbidden, uma vez que não possui um method válido."],"type":"text/javascript"}}],"id":"add7f538-400f-4540-8e40-d846eefdc74f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"OBJ","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Token de autenticação PagSeguro

\n","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X_CLIENT_ID","value":"{{client_id}}","type":"text"},{"key":"X_CLIENT_SECRET","value":"{{client_secret}}","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"

Possibilidades: pt-br ou en

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"ACCO_737348328392943\",\n \"type\": \"SELLER\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"token\": {\n \"token_type\": \"bearer\",\n \"access_token\": \"2YotnF67589ZFEjr1zCsicMWpAA\",\n \"expires_in\": \"36000\",\n \"refresh_token\": \"tGzv3JOkF078300XG5Qx2TlKWIA\",\n \"scope\": \"accounts.read payments.create\"\n },\n \"email\": \"pagseguro@sandboxpagseguro.com.br\",\n \"business_category\": \"LEGAL_SERVICE\",\n \"person\": {\n \"birth_date\": \"2004-07-03\",\n \"name\": \"Nome completo sem abreviações exatamente como consta no documento\",\n \"tax_id\": \"09555683743\",\n \"mother_name\": \"Nome completo da mãe sem abreviações exatamente como consta no documento\",\n \"address\": {\n \"region_code\": \"SP\",\n \"city\": \"Nome da cidade sem caracteres especiais\",\n \"postal_code\": \"65432467\",\n \"street\": \"Nome da rua sem caracteres especiais\",\n \"number\": \"170\",\n \"complement\": \"Bloco do predio\",\n \"locality\": \"Nome do bairro sem caracteres especiais\",\n \"country\": \"BRA\"\n },\n \"phones\": [\n {\n \"area\": \"11\",\n \"country\": \"55\",\n \"number\": \"982247672\"\n }\n ]\n },\n \"company\": {\n \"name\": \"Razao Social exatamente como consta no documento\",\n \"tax_id\": \"04607332000190\",\n \"address\": {\n \"region_code\": \"SC\",\n \"city\": \"Nome da cidade sem caracteres especiais\",\n \"postal_code\": \"65432467\",\n \"street\": \"Nome da rua sem caracteres especiais\",\n \"number\": \"170\",\n \"complement\": \"\",\n \"locality\": \"Nome do bairro sem caracteres especiais\",\n \"country\": \"BRA\"\n },\n \"phones\": [\n {\n \"area\": \"11\",\n \"country\": \"55\",\n \"number\": \"982247672\"\n }\n ]\n },\n \"tos_acceptance\": {\n \"user_ip\": \"IP VÁLIDO\",\n \"date\": \"2019-04-17T20:07:07.002-02\"\n }\n}\n"},"url":"{{url}}/accounts","description":"

Parâmetros e objetos que compõe uma Conta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`type`	ENUM	`REQUEST: Sim` `RESPONSE: Sim`	Tipo de conta que deve ser criada. Valores possíveis: BUYER (comprador), SELLER (vendedor).
`id`	String (47 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Identificador próprio do recurso composto por um “MODIFICADOR” + um “UUID” sempre usando letras maiúsculas. Para o recurso de contas, é esperado um ACCO_UUID.
`business_category`	ENUM	`REQUEST: Condicional` `RESPONSE: Condicional`	Classificação do negócio que deve ser informada para toda conta com type SELLER
`email`	String (60 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	E-mail utilizado no login da conta.
`person`	Object	`REQUEST: Sim` `RESPONSE: Sim`	Dados do dono da conta ou de um sócio em caso de contas para empresas. Apenas um sócio deverá ser informado para esse caso.
`company`	Object	`REQUEST: Opcional` `RESPONSE: Sim`	Dados de cadastro da empresa em caso de contas para pessoas jurídicas (Seller).
`created_at`	Datetime	`REQUEST: Não` `RESPONSE: Sim`	Data e horário em que foi criada o recurso de accounts.
`tos_accpetance`	Object	`REQUEST: Sim` `RESPONSE: Sim`	Aceite do termos de aceite por parte do dono da conta na plataforma do parceiro.

Objeto Person

Campo	Tipo	Presença	Descrição
`name`	String (50 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Nome completo do usuário ou do sócio.
`birth_date`	Datetime	`REQUEST: Sim` `RESPONSE: Sim`	Data de nascimento do usuário ou do sócio. Formato a ser informado: yyyy-MM-dd
`mother_name`	String (50 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Nome da mãe do dono da conta ou do sócio.
`tax_id`	Int (20 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	CPF do dono da conta ou do único sócio a ser informado.
`address`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do endereço
└──`region_code`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Abreviação dos estados. Atualmente, apenas estados brasileiros são permitidos. Exemplo: MG, SP, RJ
└──`city`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Cidades sem assento ou caracteres especiais.
└──`postal_code`	Int (8 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	CEP válido com formatação ou sem.
└──`street`	String (1-150 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Informar o nome da rua sem caracteres especiais.
└──`number`	String (1-8 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número da casa ou do apartamento.
└──`complement`	String (1-40 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Número do apartamento, identificação de bloco.
└──`locality`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Bairro.
└──`country`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país. No momento, apenas o valor BRA é aceito.
`phones`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo uma lista de telefones de contato.
└──`area`	Int (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código DDD de telefone correspondente ao país. Atualmente, apenas o código para telefones brasileiros são permitidos. Exemplos: 31,11,46, etc.
└──`country`	Int (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país no telefone. Apenas telefones com DDI 55 são aceitos.
└──`number`	Int (8 - 9 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Um número de celular válido. O limite de telefones aceito é 1 e apenas telefone celular é aceito.

Objeto tos_acceptance

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`user_ip`	String (50 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	IP que identifica o dispositivo em que o dono da conta concordou com os termos de aceite na plataforma do parceiro.
`date`	Datetime	`REQUEST: Sim` `RESPONSE: Sim`	Momento em que o usuário concordou com os termos de aceite na plataforma do parceiro.

Objeto Company

Campo	Tipo	Presença	Descrição
`name`	String (140 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	Razão Social.
`tax_id`	Int (20 caracteres)	`REQUEST: Sim` `RESPONSE: Sim`	CNPJ
`address`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do endereço
└──`region_code`	Int (2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Abreviação dos estados. Atualmente, apenas estados brasileiros são permitidos. Exemplo: MG, SP, RJ
└──`city`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Cidades sem assento ou caracteres especiais.
└──`postal_code`	String (9 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	CEP válido, com ou sem formatação.
└──`street`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Informar o nome da rua sem caracteres especiais.
└──`number`	String (1-8 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número da casa ou do apartamento.
└──`complement`	String (1-40 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Número do apartamento, identificação de bloco.
└──`locality`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Bairro.
└──`country`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país. No momento, apenas BRA é aceito.
`phones`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo uma lista de telefones de contato.
└──`area`	Int (2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código DDD de telefone correspondente ao país. Atualmente, apenas o código para telefones brasileiros são permitidos. Exemplo: 31, 11, 46, etc.
└──`country`	Int (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país no telefone. Apenas telefones com DDI 55 são aceitos.
└──`number`	Int (8 - 9 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número de telefone da empresa. Apenas um telefone fixo ou celular deve ser informado.

Objeto token

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`token`	Object	`REQUEST: Não` `RESPONSE: Sim`	Conjunto de informações atrelados ao token gerado que relaciona a conta do parceiro e a conta criada por ele (vendedor ou comprador).
└──`refresh_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token para atualizar o `access_token`.
└──`token_type`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Sempre terá um valor de `bearer`.
└──`access_token`	String (100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Token de acesso e autenticação.
└──`expires_in`	Int (10 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Tempo de validade do `access_token` .
└──`scope`	String (150 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Permissões que foram concedidas.
Para contas tipo `BUYER`, o único escopo possível é o accounts.read. Para contas tipo `SELLER`, os escopos criados são accounts.read e payments.create.

Composição do Erro

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`error_messages`	Object	`REQUEST: Não` `RESPONSE: Condicional`	Presente nos casos em que a conta não foi criada
└──`code`	Int (5 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Código do erro. Consulte a documentação para detalhamento dos códigos.
└──`description`	String (XX caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Descrição do erro.
└──`parameter_name`	String (XX caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Especificação do nome do parâmetro em que o erro foi encontrado.
└──`errors`	String (XX caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Mensagem explicativa sobre o erro.

","urlObject":{"path":["accounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"add7f538-400f-4540-8e40-d846eefdc74f"},{"name":"Criando uma conta","event":[{"listen":"test","script":{"id":"53659dc4-e00e-4f80-9308-a987d426c12d","exec":[""],"type":"text/javascript"}}],"id":"384ae9fb-d661-4adb-b6d4-ad62b154bf8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-Language","value":"pt-br","description":"

Valores possíveis: pt-br ou en

\n","type":"text"},{"key":"x-client-id","value":"{{client_id}}","type":"text"},{"key":"x-client-secret","value":"{{client_secret}}","type":"text"},{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"TESTE LTDA\",\r\n \"tax_id\": \"11111111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts","urlObject":{"protocol":"https","path":["accounts"],"host":["sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"425309d2-f941-4e40-a8f3-cc065a79c5c7","name":"Erro de request","originalRequest":{"method":"POST","header":[{"key":"Idempotency-key","value":"chave de idempotência","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"\",\r\n \"email\": \"pagseguro@uolinc.com\",\r\n \"business_category\": \"LEGAL_SERVICE\",\r\n \"person\": {\r\n \"birth_date\": \"2004-07-03\",\r\n \"name\": \"Nome completo\",\r\n \"tax_id\": \"09555683743\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Nome da cidade sem caracteres especiais\",\r\n \"postal_code\": \"65432467\",\r\n \"street\": \"Nome da rua sem caracteres especiais\",\r\n \"number\": \"170\",\r\n \"complement\": \"Bloco do predio\",\r\n \"locality\": \"Nome do bairro sem caracteres especiais\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"982247672\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"company_name\": \"Razao Social\",\r\n \"tax_id\": \"04607332000190\",\r\n \"address\": {\r\n \"region_code\": \"SC\",\r\n \"city\": \"Nome da cidade sem caracteres especiais\",\r\n \"postal_code\": \"65432467\",\r\n \"street\": \"Nome da rua sem caracteres especiais\",\r\n \"number\": \"170\",\r\n \"complement\": \"\",\r\n \"locality\": \"Nome do bairro sem caracteres especiais\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"982247672\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"IP VÁLIDO\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Dec 2020 12:19:24 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40002\",\n \"parameter_name\": \"type\",\n \"description\": \"Required parameter.\",\n \"errors\": [\n \"The field must be filled.\"\n ]\n }\n ]\n}"},{"id":"55baf81d-373a-4852-a753-21a49a56fe6b","name":"Criando uma conta","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"123","type":"text"},{"key":"x-client-secret","value":"123","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"Valores possíveis: pt-br ou en","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"TESTE LTDA\",\r\n \"tax_id\": \"11111111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2ac31c31-3cd3-47c4-ab81-c2194b5d6072","name":"Criar uma conta BUYER","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"123","type":"text"},{"key":"x-client-secret","value":"123","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"Valores possíveis: pt-br ou en","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"BUYER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"ACCO_123\",\r\n \"created_at\": \"2021-07-23T15:17:12.115601-03:00\",\r\n \"token\": {\r\n \"token_type\": \"Bearer\",\r\n \"access_token\": \"123\",\r\n \"expires_in\": 123456,\r\n \"refresh_token\": \"123\",\r\n \"scope\": \"accounts.read\"\r\n },\r\n \"type\": \"BUYER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}"},{"id":"3d55ae0e-2849-4b19-bbb9-d03335979206","name":"Criando uma conta SELLER (PF)","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"123","type":"text"},{"key":"x-client-secret","value":"123","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"Valores possíveis: pt-br ou en","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"TESTE LTDA\",\r\n \"tax_id\": \"11111111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"ACCO_123\",\r\n \"created_at\": \"2021-07-23T15:17:12.115601-03:00\",\r\n \"token\": {\r\n \"token_type\": \"Bearer\",\r\n \"access_token\": \"123\",\r\n \"expires_in\": 123456,\r\n \"refresh_token\": \"123\",\r\n \"scope\": \"accounts.read\"\r\n },\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}"},{"id":"0b416ab5-3e1d-4123-b98d-3257fdcc8575","name":"Criando uma conta SELLER (PJ)","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"123","type":"text"},{"key":"x-client-secret","value":"123","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"Valores possíveis: pt-br ou en","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"ACCO_123\",\r\n \"created_at\": \"2021-07-23T15:17:12.115601-03:00\",\r\n \"token\": {\r\n \"token_type\": \"Bearer\",\r\n \"access_token\": \"123\",\r\n \"expires_in\": 123456,\r\n \"refresh_token\": \"123\",\r\n \"scope\": \"accounts.read\"\r\n },\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}"},{"id":"212c0c83-2778-4f8f-bbfa-99254adb2f95","name":"Criando uma conta ENTERPRISE","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"123","type":"text"},{"key":"x-client-secret","value":"123","type":"text"},{"key":"Accept-Language","value":"pt-br","description":"Valores possíveis: pt-br ou en","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"trade_name\": \"Teste LTDA\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"ACCO_123\",\r\n \"created_at\": \"2021-07-23T15:17:12.115601-03:00\",\r\n \"token\": {\r\n \"token_type\": \"Bearer\",\r\n \"access_token\": \"123\",\r\n \"expires_in\": 123456,\r\n \"refresh_token\": \"123\",\r\n \"scope\": \"accounts.read\"\r\n },\r\n \"type\": \"SELLER\",\r\n \"email\": \"teste@sandboxpagseguro.com.br\",\r\n \"person\": {\r\n \"birth_date\": \"1994-07-03\",\r\n \"name\": \"João da Silva\",\r\n \"tax_id\": \"11111111111\",\r\n \"mother_name\": \"Maria da Silva\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"São Paulo\",\r\n \"postal_code\": \"00000000\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"981111111\"\r\n }\r\n ]\r\n },\r\n \"company\": {\r\n \"name\": \"Teste LTDA\",\r\n \"tax_id\": \"00000000000000\",\r\n \"trade_name\": \"Teste LTDA\",\r\n \"address\": {\r\n \"region_code\": \"SP\",\r\n \"city\": \"Sao Paulo\",\r\n \"postal_code\": \"11111111\",\r\n \"street\": \"Rua São Paulo\",\r\n \"number\": \"1\",\r\n \"complement\": \"A\",\r\n \"locality\": \"Centro\",\r\n \"country\": \"BRA\"\r\n },\r\n \"phones\": [\r\n {\r\n \"area\": \"11\",\r\n \"country\": \"55\",\r\n \"number\": \"911111111\"\r\n }\r\n ]\r\n },\r\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\r\n \"tos_acceptance\": {\r\n \"user_ip\": \"127.0.0.1\",\r\n \"date\": \"2019-04-17T20:07:07.002-02\"\r\n }\r\n}"}],"_postman_id":"384ae9fb-d661-4adb-b6d4-ad62b154bf8d"},{"name":"Consultando uma conta","event":[{"listen":"test","script":{"id":"2d9ab8be-979a-4a70-9e32-4ead1237b457","exec":[""],"type":"text/javascript"}}],"id":"e9e3d06b-342c-473d-97e9-9e738ebe154b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-client-token","value":"{{client_token}}","type":"text"},{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox.api.pagseguro.com/accounts/{{account_id}}","urlObject":{"protocol":"https","path":["accounts","{{account_id}}"],"host":["sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"67aaefdb-c098-4fe5-b285-677244e7bd45","name":"Consultando uma conta","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-client-token","value":"token","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://sandbox.api.pagseguro.com/accounts/ACCO_123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ACCO_123\",\n \"type\": \"SELLER\",\n \"status\": \"ACTIVE\",\n \"created_at\": \"2021-07-23T14:56:33.815352\",\n \"email\": \"teste@sandbox.pagseguro.com\",\n \"business_category\": \"ARCHITECTURAL_AND_ENGINEERING\",\n \"person\": {\n \"birth_date\": \"1994-07-03\",\n \"name\": \"TESTE LTDA\",\n \"tax_id\": \"11111111111111\",\n \"mother_name\": \"Maria da Silva\",\n \"address\": [\n {\n \"region_code\": \"SP\",\n \"city\": \"São Paulo\",\n \"postal_code\": \"00000000\",\n \"street\": \"Rua São Paulo\",\n \"number\": \"1\",\n \"complement\": \"A\",\n \"locality\": \"Centro\"\n }\n ],\n \"phones\": [\n {\n \"area\": \"11\",\n \"country\": \"55\",\n \"number\": \"981111111\"\n }\n ]\n }\n}"}],"_postman_id":"e9e3d06b-342c-473d-97e9-9e738ebe154b"}],"id":"279a588f-60a7-4169-88b6-ceb45a334738","description":"

INTRODUÇÃO

A API é destinada para Parceiros PagSeguro PagBank que precisam criar contas em nome de terceiros.

A conta criada é uma conta PagBank simples apta a transacionar. Para acessar e movimentar o saldo das vendas nas contas criadas, vendedores, donos da conta, devem encaminhar uma foto do documento via aplicativo PagBank e cadastrar uma senha.

Caso o cliente já tenha uma conta PagBank aberta, será preciso conectar à conta do usuário através da Connect. Obtendo autorização para realizar ações em nome do usuário PagSeguro.

Para conhecer melhor as funcionalidades que serão disponibilizadas para seus vendedores e compradores:

Conta digital sem tarifas e taxas de manutenção;
As transferências de dinheiro para outras contas são gratuitas;
Por meio da conta digital é possível efetuar pagamentos gratuitamente;
Acesso a empréstimos pessoais;
Maior rendimento do dinheiro depositado;
Saques nos caixas do Banco24horas;\nCartão de débito, etc.

O Recurso contas (accounts) em sua definição representa a criação de uma conta através de um objeto person e um objeto company, contendo informações necessárias exclusivamente para esse fim. De acordo com o tipo de conta escolhida pode ser necessário informar mais ou menos dados.

É possível criar os seguintes tipos de contas:

Buyer - conta comprador criada para pessoas físicas
Seller - conta vendedor criada para pessoa física e jurídica, conta apta a vender

Para criar uma conta tipo SELLER é necessário informar uma categoria de negócio.

A categoria de negócio corresponde à classificação do negócio dos usuários. O campo é um ENUM. Os seguintes valores são possíveis:

Business Category

Descrição simplificada	Valor (ENUM)
Açougue	`BUTCHERY`
Advogados e Serviços Legais	`LEGAL_SERVICE`
Alfaiates/Costureiras	`TAILOR_AND_SEAMSTRESS`
Ambulante	`ITINERANT_SALE`
Arquiteto e Engenheiro	`ARCHITECTURAL_AND_ENGINEERING`
Arte e Antiguidades	`ART_AND_ANTIQUE`
Artigos Religiosos	`RELIGION_AND_SPIRITUALITY`
Automóveis e Acessórios	`VEHICLE_AND_PARTS`
Bebês	`BABY`
Borracheiro/Mecânico/Funilaria/Pintura	`VEHICLE_SERVICES`
Cabelereiro/Barbeiro/Manicure	`BEAUTY_AND_BARBER`
Cama, Mesa e Banho	`BED_AND_BATH`
Celulares e Telefonia	`TELECOMMUNICATION`
Chaveiro	`KEY_CHAIN`
Comércio de bebidas	`PACKAGE_STORE`
Comida, Bebida e Nutricional	`FOOD_SERVICE`
Conteúdo Adulto	`ADULT_CONTENT`
Corretor de imobiliária	`REAL_ESTATE_AGENT`
Corretor de seguro	`BROKER`
Dentista/Ortodontista	`DENTISTRY`
Despachante	`FREIGHT_FORWARDER`
Doces e confeitarias	`CANDIES_AND_CONFECTIONERIES`
Eletrônicos / Eletrodomésticos	`HOUSEHOLD_APPLIANCE`
Empreiteiros Autonomos	`GENERAL_CONTRACTOR`
Entidades Públicas	`GOVERNMENT`
Esporte	`SPORT`
Esteticista / Massagista	`HEALTH_AND_BEAUTY_SERVICE`
Feira Livre	`NONDURABLE_GOODS`
Fisioterapeutas/Fonoaudioólogos/Nutricionista/Psicológo/Enfermeiros	`MEDICAL_SERVICE`
Fotografia e gravação	`PHOTOGRAPHY_AND_VIDEO`
Hipermercado/mercado/minimercado	`SUPERMARKET`
Hospedagem e Turismo	`LODGING`
Jardineiro/Florista/Paisagista	`FLORIST`
Jóias e Relógios	`JEWELRY_AND_WATCH`
Marceneiros/Serralheiros/Vidraceiros	`OTHER_SERVICES`
Médicos em geral	`DOCTOR`
Móveis e Decoração	`FURNITURE_AND_DECORATION`
Padaria	`BAKERY`
Personal Trainer	`PERSONAL_TRAINER`
Pet Shop	`PET_SUPPLIES`
Podólogos/Pedicuros	`PODIATRIST_AND_CHIROPODIST`
Reparos diversos	`REPAIR_SHOPS`
Restaurantes e similares	`RESTAURANT`
Roupas e Acessórios	`CLOTHING_AND_ACCESSORIES`
Sapateiro	`SHOE_STORE`
Serviços de Educação	`EDUCATION`
Serviços de recreação e lazer	`ENTERTAINMENT`
Serviços profissionais diversos	`PROFESSIONAL_SERVICE`
Tatuadores	`TATTOOIST`
Táxi - Autonomos	`TRANSPORTATION_SERVICE`
Telecomunicações	`TELECOM`
Vendas à Domicílio	`DOOR_TO_DOOR_SALES`
Veterinários	`VETERINARY_SERVICE`

ERROS

Para que uma conta seja criada, determinadas regras de negócio precisam ser seguidas, como:

Os dados mínimos obrigatórios devem ser informados dentro do formato esperado;
O dono da conta precisa ser maior de 18 anos ou maior de 16 anos emancipado;
O conjunto de dados precisa ser validado em uma análise de KYC (know your customer). Isso significa que os documentos do dono da conta precisam estar regularizados perante a Receita Federal;
Os dados informados devem ser exatamente iguais ao documento (CPF) e ao cartão do CNPJ (quando se tratar de conta PJ).

Atenção!
\nSerá possível escolher, via header, o idioma da mensagem de erro. Os idiomas disponíveis são: en ou pt-br.

Os erros são compostos pelas seguintes informações:

Código de erro: código numérico que representa a classe do erro. Exemplo: 40001, 40002, etc;
Descrição: classificação do erro. Exemplo: Parâmtero obrigatório, Parâmetro inválido, etc;
Parâmetro: campo no payload em que o erro aconteceu. Exemplo: person.name, email,tax_id.company, etc;
Mensagem: descrição detalhada do motivo do erro. O objetivo é informar todas as correções necessárias a serem aplicadas no payload para que a uma conta seja criada com sucesso.

Em caso de alguma condição não for atendida, erros retornados pela API deixarão claro qual o que aconteceu. A seguir, temos a seguinte lista de erros:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código do erro	Descrição	Significado
40001	Parâmetro obrigatório	Algum dado obrigatório não foi informado
40002	Parâmetro inválido	Algum dado foi informado com formato inválido ou o conjunto de dados não cumpriu todos os requisitos de negócio
42001	Falha na criação de conta	A conta já existe no PagSeguro PagBank. Para ter acesso aos dados dessa conta ou criar pagamentos em nome do dono da conta, é necessário solicitar permissão via Connect.
42002	Falha na criação de conta	O processo de criação foi iniciado por outro canal diferente da API. O usuário precisa acessar o email para finalizar a criação de conta.

Atenção!
\nTodas as contas criadas em sandbox serão automaticamente consideradas aprovadas no KYC dada a impossibilidade de simular determinado cenário.

Atenção!
\nPara conseguir criar uma conta com sucesso, o seguinte domínio de e-mail deve ser utilizado: @sandbox.pagseguro.com.br

\n","_postman_id":"279a588f-60a7-4169-88b6-ceb45a334738"},{"name":"Charges","item":[{"name":"Objeto Cobrança","event":[{"listen":"test","script":{"exec":["pm.test(\"Object Example - Method is not valid\", function () {"," pm.response.to.have.status(403);","});","","// Essa chamada, caso executada, deverá retornar um 403 Forbidden, uma vez que não possui um method válido."],"type":"text/javascript","id":"5c757723-5754-4dee-8d06-0cf153a651d0"}}],"id":"ad9e0eb9-4e47-4d9e-8a0a-ed4a88cb456c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"OBJ","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Token de autenticação PagSeguro

\n","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"description":"

Chave de idempotência

\n","key":"X-idempotency-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n }\n}"},"url":"{{url}}/charges","description":"

Parâmetros e objetos que compõe uma Cobrança

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`id`	String (41 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Identificador da cobrança PagSeguro.
`status`	String (1-64 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Status da cobrança. - `AUTHORIZED` Indica que a cobrança está pré-autorizada. - `PAID` Indica que a cobrança está paga (capturada). - `IN_ANALYSIS` Indica que o comprador optou por pagar com um cartão de crédito e o PagSeguro está analisando o risco da transação. - `DECLINED` Indica que a cobrança foi negada pelo PagSeguro ou Emissor. - `CANCELED` Indica que a cobrança foi cancelada.
`created_at`	Datetime	`REQUEST: Não` `RESPONSE: Sim`	Data e horário em que foi criada a cobrança.
`paid_at`	Datetime	`REQUEST: Não` `RESPONSE: Condicional`	Data e horário em que a cobrança foi paga (capturada).
`reference_id`	String (1-64 caracteres)	`REQUEST: Opcional` `RESPONSE: Condicional`	Identificador próprio atribuído para a cobrança.
`description`	String (1-64 caracteres)	`REQUEST: Opcional` `RESPONSE: Condicional`	Descrição da cobrança. Tamanho: 1-64 caracteres alfanuméricos.
`amount`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do valor a ser cobrado
└──`value`	Int (9 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Valor a ser cobrado em centavos. Apenas números inteiros positivos. Exemplo: - R$ 1.500,99 = 150099
└──`currency`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código de moeda ISO de três letras, em maiúsculas. Por enquanto, apenas o Real brasileiro é suportado (“BRL”)
└──`summary`	Object	`REQUEST: Não` `RESPONSE: Sim`	Objeto contendo um resumo de valores da cobrança.
└──└──`total`	Int (9 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Valor total da cobrança.
└──└──`paid`	Int (9 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Valor que foi pago na Cobrança.
└──└──`refunded`	Int (9 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Valor que foi devolvido da Cobrança.
`payment_response`	Object	`REQUEST: Não` `RESPONSE: Sim`	Objeto contendo informações de Resposta do Provedor de Pagamento.
└──`code`	Int (5 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Código PagSeguro que indica o motivo da resposta de autorização no pagamento, tanto para pagamento autorizado, quando para negada. Veja a lista com detalhamento dos códigos aqui.
└──`message`	String (5-100 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Mensagem amígável descrevendo motivo da não aprovação ou autoização da cobrança. Compátivel com padrão ABECS - Normativo 21.
└──`reference`	String (4-20 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	NSU da autorização, caso o pagamento seja aprovado pelo Emissor.
`payment_method`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do método de pagamento da cobrança
└──`type`	String (ENUM)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Indica o método de pagamento usado na cobrança. - `CREDIT_CARD` ou `DEBIT_CARD` Se o método de pagamento utilizado for cartão de crédito, cartão de débito ou token de rede, será obrigatório o envio do objeto `payment_method.card`. - `BOLETO` Se o método de pagamento utilizado for boleto bancário, será obrigatório o envio do objeto `payment_method.boleto`.
└──`installments`	Int (2 caracteres)	`REQUEST: Condicional` `RESPONSE: Condicional`	Quantidade de parcelas. Apenas números inteiros positivos. Obrigatório para o método de pagamento cartão de crédito.
└──`capture`	Boolean (true/false)	`REQUEST: Condicional` `RESPONSE: Condicional`	Parâmetro que indica se uma transação de cartão de crédito deve ser apenas pré-autorizada (reserva o valor da cobrança no cartão do cliente por até 5 dias) ou se a transação deve ser capturada automaticamente (cobrança realizada em apenas um passo). - Informar `false` para pré-autorizar - Ou `true` para cobrança em um passo. Obrigatório para o método de pagamento cartão de crédito. Função indisponível para o método de pagamento cartão de débito e token de rede (débito). Bandeiras de cartão de crédito: - `VISA` - `MASTERCARD` - `AMEX` - `ELO` Bandeiras de token de rede (crédito): - `VISA` - `MASTERCARD` - `ELO`
└──`soft_descriptor`	String (0-17 caracteres)	`REQUEST: Condicional` `RESPONSE: Condicional`	Parâmetro responsável pelo que será exibido como Nome na Fatura do cliente (Aplicável no momento apenas para Cartão de crédito) - Não permite caracteres especiais. (Acentuações serão substituidas por caracteres sem acentos, demais caracteres especiais serão removidos)
└──`card`	Object	`REQUEST: Condicional` `RESPONSE: Condicional`	Objeto contendo os dados de cartão de crédito, cartão de débito ou token de rede. Obrigatório para o método de pagamento com cartão ou token de rede.
└──└──`id`	String (41 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Identificador PagSeguro do cartão de crédito salvo (Cartão Tokenizado pelo PagSeguro). Função indisponível para o método de pagamento cartão de débito e token de rede.
└──└──`number`	String (14-19 caracteres)	`REQUEST: Condicional` `RESPONSE: Não`	Número do cartão de crédito ou cartão de débito.
└──└──`network_token`	String (14-19 caracteres)	`REQUEST: Condicional` `RESPONSE: Não`	Número do token de rede.
└──└──`exp_month`	Int (1/2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Mês de expiração do cartão de crédito, cartão de débito ou token de rede.
└──└──`exp_year`	Int (2/4 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Ano de expiração do cartão de crédito, cartão de débito ou token de rede.
└──└──`security_code`	String (3/4 caracteres)	`REQUEST: Opcional` `RESPONSE: Não`	Código de Segurança do cartão de crédito, cartão de débito ou token de rede.
└──└──`store`	Boolean (true/false)	`REQUEST: Condicional` `RESPONSE: Condicional`	Indica se o cartão deverá ser armazenado no PagSeguro para futuras compras. - Se informar `false`, ou omitir esse parâmetros não será armazenado. - Informe`true` para que seja armazenado, na resposta da requisição você terá o token do cartão em `payment_method.card.id`. Função indisponível para o método de pagamento cartão de débito e token de rede.
└──└──`brand`	String (20 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Bandeiras de cartão de crédito: - `VISA` - `MASTERCARD` - `AMEX` - `ELO` - `HIPERCARD` - `HIPER` - `DINERS` Bandeiras de cartão de débito: - `VISA` - `MASTERCARD` - `ELO` Bandeiras de token de rede: - `VISA` - `MASTERCARD` - `ELO`
└──└──`first_digits`	Int (6 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Seis primeiros números do cartão ou token de rede (BIN).
└──└──`last_digits`	Int (4 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Quatro últimos números do cartão ou token de rede.
└──└──`holder`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do portador do cartão de crédito, cartão de débito e token de rede.
└──└──└──`name`	String (1-30 caracteres)	`REQUEST: Condicional` `RESPONSE: Condicional`	Nome do portador do cartão de crédito, cartão de débito e token de rede. Obrigatório para cobranças com 3DS e Criptografia.
└──└──└──`tax_id`	String (11/14 caracteres)	`REQUEST: Opcional` `RESPONSE: Condicional`	Número do documento do portador do cartão de crédito, cartão de débito e token de rede.
└──`token_data`	Object	`REQUEST: Condicional` `RESPONSE: Condicional`	Objeto contendo os dados adicionais de Tokenização de Rede. Deve ser enviado quando um cartão de crédito ou débito tokenizado pelas bandeiras `Visa` ou `Mastercard` é utilizado.
└──└──`requestor_id`	String(11)	`REQUEST: Opcional` `RESPONSE: Condicional`	Identificador de quem gerou o token de rede (Token Requestor).
└──└──`wallet`	String (ENUM)	`REQUEST: Opcional` `RESPONSE: Condicional`	Tipo de carteira que armazenou o token de rede. - `APPLE_PAY` - `GOOGLE_PAY` - `SAMSUNG_PAY` - `MERCHANT_TOKENIZATION_PROGRAM`
└──└──`cryptogram`	String(40)	`REQUEST: Obrigatório` `RESPONSE: Não`	Criptograma gerado pela bandeira.
└──└──`ecommerce_domain`	String(150)	`REQUEST: Opcional` `RESPONSE: Condicional`	Identificador do domínio de origem da transação, comumente caracterizado em um formato de domínio reverso. Ex: br.com.pagseguro
└──└──`assurance_level`	Int(2)	`REQUEST: Opcional` `RESPONSE: Condicional`	Conteúdo que indica o nível de confiança do token de rede.
└──`authentication_method`	Object	`REQUEST: Condicional` `RESPONSE: Sim`	Objeto contendo os dados adicionais de autenticação vínculados à uma transação. Obrigatório quando `payment_method.type = DEBIT_CARD`
└──└──`type`	String(ENUM)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Indica o método de autenticação utilizado na cobrança. - `THREEDS` Se o método de autenticação utilizado for 3DS. - `INAPP` Se o método de autenticação utilizado for InApp. Condicional para Token de Rede ELO.
└──└──`cavv`	String(80)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Identificador único gerado em cenário de sucesso de autenticação do cliente.
└──└──`eci`	String (2)	`REQUEST: Obrigatório` `RESPONSE: Sim`	E-Commerce indicator retornado quando ocorre uma autenticação. Corresponde ao resultado da autenticação.
└──└──`xid`	String(80)	`REQUEST: Opcional` `RESPONSE: Sim`	Identificador de uma transação de um MPI. Recomendado para a bandeira VISA. Condicional para 3DS.
└──└──`version`	String(10)	`REQUEST: Condicional` `RESPONSE: Sim`	Versão do protocolo 3DS utilizado na autenticação. - `2.0.1` - `2.2.0` - `1.0.2`
└──└──`dstrans_id`	String(80)	`REQUEST: Opcional` `RESPONSE: Sim`	ID da transação gerada pelo servidor de diretório durante uma autenticação. Recomendado para a bandeira Mastercard. Condicional para 3DS.
└──└──`status`	String(80)	`REQUEST: Não` `RESPONSE: Condicional`	Status de uma autenticação 3DS. - `AUTHENTICATED` - `NOT AUTHENTICATED`
└──`boleto`	Object	`REQUEST: Condicional` `RESPONSE: Condicional`	Objeto contendo os dados para geração do boleto
└──└──`due_date`	String (10 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Data de vencimento do boleto. Formato: “yyyy-MM-dd”
└──└──`instruction_lines`	Object	`REQUEST: Opcional` `RESPONSE: Condicional`	Objeto contendo as linhas de instrução do boleto
└──└──└──`line_1`	String (1-75 caracteres)	`REQUEST: Opcional` `RESPONSE: Condicional`	Primeira linha de instruções sobre o pagamento do boleto.
└──└──└──`line_2`	String (1-75 caracteres)	`REQUEST: Opcional` `RESPONSE: Condicional`	Segunda linha de instruções sobre o pagamento do boleto.
└──└──`holder`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do responsável pelo pagamento do boleto
└──└──└──`name`	String (1-30 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Nome do responsável pelo pagamento do boleto. Tamanho: alfanuméricos.
└──└──└──`tax_id`	String (11/14 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número do documento do responsável pelo pagamento do boleto.
└──└──└──`email`	String (10-255 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	E-mail do responsável pelo pagamento do boleto.
└──└──└──`address`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações de endereço do responsável pelo pagamento do boleto
└──└──└──└──`street`	String (1-100 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Rua do endereço de cobrança do responsável pelo pagamento do boleto.
└──└──└──└──`number`	String (1-20 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número do endereço de cobrança do responsável pelo pagamento do boleto.
└──└──└──└──`locality`	String (1-100 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Bairro do endereço de cobrança do responsável pelo pagamento do boleto.
└──└──└──└──`city`	String (1-100 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Cidade do endereço de cobrança do responsável pelo pagamento do boleto.
└──└──└──└──`region`	String (1-200 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Estado do endereço de cobrança do responsável pelo pagamento do boleto.
└──└──└──└──`region_code`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do Estado do endereço de cobrança do responsável pelo pagamento do boleto. Padrão ISO 3166-2.
└──└──└──└──`postal_code`	String (8 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	CEP do endereço de cobrança do responsável pelo pagamento do boleto
`recurring`	Object	`REQUEST: Condicional` `RESPONSE: Condicional`	Objeto contendo as informações da recorrência. Os clientes que possuem recorrência própria devem utilizar esse parâmetro para indicar ao PagSeguro que a cobrança está relacionada a um pagamento recorrente. A utilização desse parâmetro não está vinculada à API de Pagamento Recorrente do PagSeguro.
└──`type`	String (ENUM)	`REQUEST: Condicional` `RESPONSE: Condicional`	Indica se a cobrança é proveniente de uma recorrência. - `INITIAL` Para a primeira cobrança da recorrencia. - `SUBSEQUENT` Para as cobranças subsequentes.
`notification_urls`	Array of String	`REQUEST: Opcional` `RESPONSE: Condicional`	URLs que serão notificadas em toda alteração ocorrida na cobrança. - Necessário que seja em ambiente seguro com SSL(HTTPS).
`metadata`	Map	`REQUEST: Opcional` `RESPONSE: Condicional`	Conjunto de pares de valores-chave que você pode anexar a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado
`links`	Array of Object	`REQUEST: Não` `RESPONSE: Sim`	Objeto contendo as informações de links relacionado ao recurso.
└──`rel`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Indica o relacionamento do recurso. - `SELF` Para o próprio recurso, ou seja a Cobrança. - `ORDER` Para um recurso do tipo Pedido.
└──`href`	String (5-2048 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Endereço HTTP do recurdo.
└──`media`	String (11-64 caracteres)	`REQUEST: Não` `RESPONSE: Sim`	Tipo de mídia ao qual o link responde ou aceita. - `application/json` - `application/pdf` - `application/image`
└──`type`	String (ENUM)	`REQUEST: Não` `RESPONSE: Sim`	Método HTTP em uso. - `GET` - `POST` - `DELETE` - `PUT`

","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"484a3f0d-10c7-4b5f-94cc-e3001f4305a0","name":"Exemplo de Cobrança com Cartão de crédito","originalRequest":{"method":"OBJ","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Token de autenticação PagSeguro","key":"Authorization","type":"text","value":"Bearer {{token_api}}"},{"description":"Versão da API","key":"x-api-version","type":"text","value":"4.0"},{"description":"Chave de idempotência (opcional)","key":"x-idempotency-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n }\n}"},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": 20000,\n \"message\": \"SUCESSO\",\n \"reference\": \"071200027526\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"ad9e0eb9-4e47-4d9e-8a0a-ed4a88cb456c"},{"name":"Criando uma cobrança com Cartão de Crédito","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r",""],"type":"text/javascript","id":"14c6faf8-f30f-4373-a65c-a7e8aff0ea97"}}],"id":"6135e4aa-4706-4107-a11a-bc300602a7fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"MyStore\",\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \t\"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \t\"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}"},"url":"{{url}}/charges","description":"

Esse recurso permite a criação de uma cobrança de pagamento com cartão de crédito ou débito. Informando os dados essências para efetivação de uma cobrança de acordo com o método de pagamento escolhido.
\n
\nMétodos de pagamento disponíveis:

Cartão de Crédito (payment_method.type = CREDIT_CARD)
Cartão de Débito (payment_method.type = DEBIT_CARD)
\n**Detalhes**\n
\nO valor mínimo por transação e parcela é definido de acordo com forma de pagamento e bandeira, no caso do cartão.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Forma de Pagamento / Bandeira	Valor Mínimo(R$)	Valor Mínimo Parcela(R$)
Cartão de Crédito / Visa	1,00	1,00
Cartão de Crédito / MasterCard	0,20	1,00
Cartão de Crédito / American Express	0,20	5,00
Cartão de Crédito / Demais Bandeiras	0,20	1,00

*Obs: Os valores apresentados podem variar de acordo com o cliente.

\n","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2d3a0bb4-f69e-4ed8-b9fe-8bfff76b1d4e","name":"Cenário 1 - Charge - Cartão de Crédito (sucesso)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"My Store\", \n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \t\"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \t\"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"paid_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": 20000,\n \"message\": \"SUCESSO\",\n \"reference\": \"071200027526\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"My Store\", \n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_erp/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/captures\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.REFUND\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/refunds\",\n \"method\": \"POST\"\n }\n ]\n}"},{"id":"39d8adc6-5f50-4e06-91ae-612579408c3a","name":"Cenário 2 - Charge - Falha de Idempotência","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"1234567891010101\",\n \"expiry_month\": \"3\",\n \"expiry_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \t\"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \t\"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40005\",\n \"description\": \"idempotency_key_in_use\",\n \"parameter_name\": \"x-idempotency-key\"\n }\n ]\n}"},{"id":"f437de32-6646-4ebb-a4da-7ae463e69443","name":"Cenário 3 - Charge - Falha de autenticação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"1234567891010101\",\n \"expiry_month\": \"3\",\n \"expiry_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \t\"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \t\"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"},{"id":"9b40115b-830e-4807-8905-cddc8948b716","name":"Cenário 4 - Charge - Falha de Requisição","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"1234567891010101\",\n \"expiry_month\": \"3\",\n \"expiry_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \t\"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \t\"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40001\",\n \"description\": \"required_parameter\",\n \"parameter_name\": \"payment_method.card.number\"\n },\n {\n \"code\": \"40002\",\n \"description\": \"invalid_parameter\",\n \"parameter_name\": \"payment_method.card.exp_month\"\n }\n ]\n}"}],"_postman_id":"6135e4aa-4706-4107-a11a-bc300602a7fa"},{"name":"Criando uma cobrança com Boleto","event":[{"listen":"test","script":{"id":"375f1819-8e2a-4bc3-9e14-cd7ef88bcbc6","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r",""],"type":"text/javascript"}}],"id":"5fb6fb58-701b-4e94-a7e2-cc3bb614363f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2024-12-31\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"city\": \"Sao Paulo\",\n \"region\": \"Sao Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"Brasil\",\n \"postal_code\": \"01452002\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}"},"url":"{{url}}/charges","description":"

Esse recurso permite a criação de uma cobrança de pagamento em boleto. Informando os dados essências para efetivação de uma cobrança de acordo com o método de pagamento escolhido.
\n
\nMétodos de pagamento disponíveis:

Boleto Bancário (payment_method.type = BOLETO)

Detalhes\n
\nO valor mínimo por transação e parcela é definido de acordo com forma de pagamento.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Forma de Pagamento / Bandeira	Valor Mínimo(R$)	Valor Mínimo Parcela(R$)
Boleto	0,20	-

","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a4a74cee-632e-486b-b599-63ae7497e670","name":"Cenário 1 - Charge - Boleto (sucesso)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2024-12-31\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"city\": \"Sao Paulo\",\n \"region\": \"Sao Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"Brasil\",\n \"postal_code\": \"01452002\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\r\n \"reference_id\": \"ex-00001\",\r\n \"status\": \"WAITING\",\r\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\r\n \"paid_at\": \"2019-04-17T20:07:07.002-02\",\r\n \"description\": \"Motivo do pagamento\",\r\n \"amount\": {\r\n \"value\": 1000,\r\n \"currency\": \"BRL\",\r\n \"summary\": {\r\n \"total\": 1000,\r\n \"paid\": 0,\r\n \"refunded\": 0\r\n }\r\n },\r\n \"payment_response\": {\r\n \"code\": 20000,\r\n \"message\": \"SUCESSO\"\r\n },\r\n \"payment_method\": {\r\n \"type\": \"BOLETO\",\r\n \"boleto\": {\r\n \"id\": \"6EA2EB96-CD24-4956-84AB-F4558B6C2097\",\r\n \"barcode\": \"03399853012970000000200726101017777550000005100\",\r\n \"formatted_barcode\": \"03399.85301 29700.000002 00726.101017 7 77550000005100\",\r\n \"due_date\": \"2024-12-31\",\r\n \"instruction_lines\": {\r\n \"line_1\": \"Pagamento processado para DESC Fatura\",\r\n \"line_2\": \"Via PagSeguro\"\r\n },\r\n \"holder\": {\r\n \"name\": \"Jose da Silva\",\r\n \"tax_id\": \"22222222222\",\r\n \"email\": \"jose@email.com\",\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"Sao Paulo\",\r\n \"region\": \"Sao Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"Brasil\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n }\r\n }\r\n },\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"href\": \"https://boleto.sandbox.pagseguro.com.br/6ea2eb96-cd24-4956-84ab-f4558b6c2097.pdf\",\r\n \"media\": \"application/pdf\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"SELF\",\r\n \"href\": \"https://boleto.sandbox.pagseguro.com.br/6ea2eb96-cd24-4956-84ab-f4558b6c2097.png\",\r\n \"media\": \"image/png\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"SELF\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\r\n \"media\": \"application/json\",\r\n \"type\": \"GET\"\r\n }\r\n ],\r\n \"notification_url\": [\r\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\r\n ]\r\n}"},{"id":"5c336679-fd0f-4697-b002-6625b453974d","name":"Cenário 2 - Charge - Falha de Idempotência","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"ex-00001","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2024-12-31\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"city\": \"Sao Paulo\",\n \"region\": \"Sao Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"Brasil\",\n \"postal_code\": \"01452002\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40005\",\n \"description\": \"idempotency_key_in_use\",\n \"parameter_name\": \"x-idempotency-key\"\n }\n ]\n}"},{"id":"67094f83-153a-42d0-9e36-66cf19ad4640","name":"Cenário 3 - Charge - Falha de autenticação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2024-12-31\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"city\": \"Sao Paulo\",\n \"region\": \"Sao Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"Brasil\",\n \"postal_code\": \"01452002\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"},{"id":"4ae6dbd8-8a05-445c-90a1-587e656082f2","name":"Cenário 4 - Charge - Falha de Requisição","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2024-12-31\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"city\": \"Sao Paulo\",\n \"region\": \"Sao Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"Brasil\",\n \"postal_code\": \"01452002\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40001\",\n \"description\": \"required_parameter\",\n \"parameter_name\": \"payment_method.card.number\"\n },\n {\n \"code\": \"40002\",\n \"description\": \"invalid_parameter\",\n \"parameter_name\": \"payment_method.card.exp_month\"\n }\n ]\n}"}],"_postman_id":"5fb6fb58-701b-4e94-a7e2-cc3bb614363f"},{"name":"Criando uma cobrança com dados de Autenticação 3DS","event":[{"listen":"test","script":{"id":"24c3be23-bc10-44ed-8e51-3061c0868e51","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r",""],"type":"text/javascript"}}],"id":"7fce86c0-d4cf-4a03-96b5-60795fd4ca80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"description\": \"Motivo do pagamento\",\r\n \"amount\": {\r\n \"value\": 1000,\r\n \"currency\": \"BRL\"\r\n },\r\n \"payment_method\": {\r\n \"type\": \"CREDIT_CARD\",\r\n \"installments\": 1,\r\n \"capture\": true,\r\n \"soft_descriptor\": \"My Store\",\r\n \"card\": {\r\n \"number\": \"4111111111111111\",\r\n \"exp_month\": \"03\",\r\n \"exp_year\": \"2026\",\r\n \"security_code\": \"123\",\r\n \"holder\": {\r\n \"name\": \"Jose da Silva\"\r\n }\r\n },\r\n \"authentication_method\": {\r\n \"type\": \"THREEDS\",\r\n \"cavv\": \"BwABBylVaQAAAAFwllVpAAAAAAA=\",\r\n \"xid\": \"BwABBylVaQAAAAFwllVpAAAAAAA=\",\r\n \"eci\": \"01\",\r\n \"version\": \"2.1.0\",\r\n \"dstrans_id\": \"DIR_SERVER_TID\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\r\n ],\r\n \"metadata\": {\r\n \"Exemplo\": \"Aceita qualquer informação\",\r\n \"NotaFiscal\": \"123\",\r\n \"idComprador\": \"123456\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges","description":"

Cobrando com dados adicionais de Autenticação 3DS

O 3DS é um protocolo de autenticação de comércio eletrônico que permite o processamento seguro de transações de cartões para pagamentos.

IMPORTANTE: Para payment_method.type = DEBIT_CARD, é obrigatória a presença do objeto authentication_method para autorização da transação. \nDe acordo com a forma de autenticação escolhida pode ser necessário informar mais ou menos dados.

Ao informar os valores no objeto authentication_method com type = THREEDS, a cobrança de uma transação previamente autenticada será realizada.

\n","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ca433da7-39be-4c9d-8e05-eb4c41037159","name":"Cenário 1 - Charge - Cartão de Crédito e 3DS (Sucesso)","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo do pagamento\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"CREDIT_CARD\",\n\t\t\"installments\":1,\n\t\t\"capture\":true,\n\t\t\"soft_descriptor\":\"My Store\",\n\t\t\"card\":{\n\t\t\t\"number\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"05\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\":\"CHAR_CF7DD60F-5762-4330-B6D2-2F3B3E5BE645\",\n\t\"reference_id\":\"ex-00001\",\n\t\"status\":\"PAID\",\n\t\"created_at\":\"2021-04-01T10:02:28.599-03:00\",\n\t\"paid_at\":\"2021-04-01T10:02:35.000-03:00\",\n\t\"description\":\"Motivo de pagamento\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\",\n\t\t\"summary\":{\n\t\t\t\"total\":1000,\n\t\t\t\"paid\":1000,\n\t\t\t\"refunded\":0\n\t\t}\n\t},\n\t\"payment_response\":{\n\t\t\"code\":\"20000\",\n\t\t\"message\":\"SUCESSO\",\n\t\t\"reference\":\"032416400102\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"CREDIT_CARD\",\n\t\t\"installments\":1,\n\t\t\"capture\":true,\n\t\t\"card\":{\n\t\t\t\"brand\":\"elo\",\n\t\t\t\"first_digits\":\"411111\",\n\t\t\t\"last_digits\":\"1111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"status\":\"AUTHENTICATED\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"05\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t},\n\t\t\"soft_descriptor\":\"My Store\"\n\t},\n\t\"links\":[\n\t\t{\n\t\t\t\"rel\":\"SELF\",\n\t\t\t\"href\":\"https://charge-orchestrator.sandbox.aws.intranet.pagseguro.uol/charges/CHAR_CF6DD60F-5762-4330-B6D2-2F3B3E5BE645\",\n\t\t\t\"media\":\"application/json\",\n\t\t\t\"type\":\"GET\"\n\t\t},\n\t\t{\n\t\t\t\"rel\":\"CHARGE.CANCEL\",\n\t\t\t\"href\":\"https://charge-orchestrator.sandbox.aws.intranet.pagseguro.uol/charges/CHAR_CF6DD60F-5762-4330-B6D2-2F3B3E5BE645/cancel\",\n\t\t\t\"media\":\"application/json\",\n\t\t\t\"type\":\"POST\"\n\t\t}\n\t],\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}"},{"id":"1643698b-948b-45cc-afb7-62766b259e98","name":"Cenário 2 - Charge - Cartão de Débito e 3DS (Sucesso)","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo de pagamento\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"DEBIT_CARD\",\n\t\t\"card\":{\n\t\t\t\"number\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"05\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\":\"CHAR_58387501-68D9-478A-AA31-E6DFCB3562D6\",\n\t\"reference_id\":\"ex-00001\",\n\t\"status\":\"PAID\",\n\t\"created_at\":\"2021-04-01T10:05:16.385-03:00\",\n\t\"paid_at\":\"2021-04-01T10:05:17.000-03:00\",\n\t\"description\":\"Motivo de pagamento\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\",\n\t\t\"summary\":{\n\t\t\t\"total\":1000,\n\t\t\t\"paid\":1000,\n\t\t\t\"refunded\":0\n\t\t}\n\t},\n\t\"payment_response\":{\n\t\t\"code\":\"20000\",\n\t\t\"message\":\"SUCESSO\",\n\t\t\"reference\":\"032416400102\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"DEBIT_CARD\",\n\t\t\"card\":{\n\t\t\t\"brand\":\"elo\",\n\t\t\t\"first_digits\":\"411111\",\n\t\t\t\"last_digits\":\"1111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"status\":\"AUTHENTICATED\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"05\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t}\n\t},\n\t\"links\":[\n\t\t{\n\t\t\t\"rel\":\"SELF\",\n\t\t\t\"href\":\"https://charge-orchestrator.sandbox.aws.intranet.pagseguro.uol/charges/CHAR_58287501-68D9-478A-AA31-E6DFCB3562D6\",\n\t\t\t\"media\":\"application/json\",\n\t\t\t\"type\":\"GET\"\n\t\t},\n\t\t{\n\t\t\t\"rel\":\"CHARGE.CANCEL\",\n\t\t\t\"href\":\"https://charge-orchestrator.sandbox.aws.intranet.pagseguro.uol/charges/CHAR_58287501-68D9-478A-AA31-E6DFCB3562D6/cancel\",\n\t\t\t\"media\":\"application/json\",\n\t\t\t\"type\":\"POST\"\n\t\t}\n\t],\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}"}],"_postman_id":"7fce86c0-d4cf-4a03-96b5-60795fd4ca80"},{"name":"Criando uma cobrança com Token de Rede","event":[{"listen":"test","script":{"id":"f6b272e3-b02d-4369-acc3-a4d1d47083fa","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r",""],"type":"text/javascript"}}],"id":"79a77144-148e-4327-bf51-cdb4d0d0b95d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"CREDIT_CARD\",\n\t\t\"installments\":1,\n\t\t\"capture\":true,\n\t\t\"card\":{\n\t\t\t\"network_token\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t},\n\t\t\t\"token_data\":{\n\t\t\t\t\"requestor_id\":\"12345678901\",\n\t\t\t\t\"wallet\":\"WALLET\",\n\t\t\t\t\"cryptogram\":\"BNQ1qJkmBYWiAAuzyDDhAoABFA==\",\n\t\t\t\t\"ecommerce_domain\":\"br.com.pagseguro\",\n\t\t\t\t\"assurance_level\":88\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"TIPO\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"01\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}"},"url":"{{url}}/charges","description":"

Uma transação com Token de Rede é caracterizada pela substituição do PAN (Primary Account Number) e da data de vencimento de um cartão de crédito ou débito por valores e data de vencimento do próprio Token.

O Token de Rede deve ser informado no campo network_token do objeto card e passará pelas regras básicas de validação de um cartão de crédito ou débito comum, incluindo o security_code.

IMPORTANTE: A Tokenização de Rede é diferente da Tokenização PagSeguro.

Com a Tokenização PagSeguro o cartão de crédito fica armazenado para compras futuras e na resposta da requisição você terá o token do cartão em payment_method.card.id.
Com a Tokenização de Redeos dados utilizados para a criação de uma transação são os do próprio Token de Rede, fornecido pelas bandeiras e que possui características similiares a um cartão de crédito ou débito.

\n","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dbf8e3b1-25f6-429c-9f0a-fb4719d8d249","name":"Cenário 1 - Charge - Token de Rede (Crédito): Visa ou Mastercard","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"CREDIT_CARD\",\n\t\t\"installments\":1,\n\t\t\"capture\":true,\n\t\t\"card\":{\n\t\t\t\"network_token\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t},\n\t\t\t\"token_data\":{\n\t\t\t\t\"requestor_id\":\"12345678901\",\n\t\t\t\t\"wallet\":\"WALLET\",\n\t\t\t\t\"cryptogram\":\"BNQ1qJkmBYWiAAuzyDDhAoABFA==\",\n\t\t\t\t\"ecommerce_domain\":\"br.com.pagseguro\",\n\t\t\t\t\"assurance_level\":88\n\t\t\t}\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"PAID\",\n \"created_at\": \"2021-07-26T17:16:22.754-03:00\",\n \"paid_at\": \"2021-07-26T17:16:24.000-03:00\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"072638986091\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"mastercard\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"3\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n },\n \"token_data\": {\n \"requestor_id\": \"12345678901\",\n \"wallet\": \"WALLET\",\n \"ecommerce_domain\": \"br.com.pagseguro\",\n \"assurance_level\": 88\n }\n }\n },\n \"notification_urls\": [],\n \"metadata\": {\n \"Key\": \"value\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"},{"id":"4ea51028-f921-4ca8-8abf-b41e35f2568c","name":"Cenário 2 - Charge - Token de Rede (Débito): Visa ou Mastercard","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"DEBIT_CARD\",\n\t\t\"card\":{\n\t\t\t\"network_token\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t},\n\t\t\t\"token_data\":{\n\t\t\t\t\"requestor_id\":\"12345678901\",\n\t\t\t\t\"wallet\":\"WALLET\",\n\t\t\t\t\"cryptogram\":\"BNQ1qJkmBYWiAAuzyDDhAoABFA==\",\n\t\t\t\t\"ecommerce_domain\":\"br.com.pagseguro\",\n\t\t\t\t\"assurance_level\":99\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"01\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\":\"CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n\t\"reference_id\":\"ex-00001\",\n\t\"status\":\"PAID\",\n\t\"created_at\":\"2021-07-26T17:16:22.754-03:00\",\n\t\"paid_at\":\"2021-07-26T17:16:24.000-03:00\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\",\n\t\t\"summary\":{\n\t\t\t\"total\":1000,\n\t\t\t\"paid\":1000,\n\t\t\t\"refunded\":0\n\t\t}\n\t},\n\t\"payment_response\":{\n\t\t\"code\":\"20000\",\n\t\t\"message\":\"SUCESSO\",\n\t\t\"reference\":\"072638986091\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"DEBIT_CARD\",\n\t\t\"card\":{\n\t\t\t\"brand\":\"mastercard\",\n\t\t\t\"first_digits\":\"411111\",\n\t\t\t\"last_digits\":\"1111\",\n\t\t\t\"exp_month\":\"3\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t},\n\t\t\t\"token_data\":{\n\t\t\t\t\"requestor_id\":\"12345678901\",\n\t\t\t\t\"wallet\":\"WALLET\",\n\t\t\t\t\"ecommerce_domain\":\"br.com.pagseguro\",\n\t\t\t\t\"assurance_level\":99\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"THREEDS\",\n\t\t\t\"status\":\"AUTHENTICATED\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"xid\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"01\",\n\t\t\t\"version\":\"2.1.0\",\n\t\t\t\"dstrans_id\":\"DIR_SERVER_TID\"\n\t\t},\n\t\t\"notification_urls\":[\n\t\t\t\n\t\t],\n\t\t\"metadata\":{\n\t\t\t\"Key\":\"value\"\n\t\t},\n\t\t\"links\":[\n\t\t\t{\n\t\t\t\t\"rel\":\"SELF\",\n\t\t\t\t\"href\":\"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n\t\t\t\t\"media\":\"application/json\",\n\t\t\t\t\"type\":\"GET\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"rel\":\"CHARGE.CANCEL\",\n\t\t\t\t\"href\":\"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5/cancel\",\n\t\t\t\t\"media\":\"application/json\",\n\t\t\t\t\"type\":\"POST\"\n\t\t\t}\n\t\t]\n\t}\n}"},{"id":"bc863c8a-f96b-4c23-86ae-47b21a762811","name":"Cenário 3 - Charge - Token de Rede (Crédito): ELO","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"CREDIT_CARD\",\n\t\t\"installments\":1,\n\t\t\"capture\":true,\n\t\t\"card\":{\n\t\t\t\"network_token\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"INAPP\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"04\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n\t\"id\":\"CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\r\n\t\"reference_id\":\"ex-00001\",\r\n\t\"status\":\"PAID\",\r\n\t\"created_at\":\"2021-07-26T17:16:22.754-03:00\",\r\n\t\"paid_at\":\"2021-07-26T17:16:24.000-03:00\",\r\n\t\"description\":\"Motivo da cobrança\",\r\n\t\"amount\":{\r\n\t\t\"value\":1000,\r\n\t\t\"currency\":\"BRL\",\r\n\t\t\"summary\":{\r\n\t\t\t\"total\":1000,\r\n\t\t\t\"paid\":1000,\r\n\t\t\t\"refunded\":0\r\n\t\t}\r\n\t},\r\n\t\"payment_response\":{\r\n\t\t\"code\":\"20000\",\r\n\t\t\"message\":\"SUCESSO\",\r\n\t\t\"reference\":\"072638986091\"\r\n\t},\r\n\t\"payment_method\":{\r\n\t\t\"type\":\"CREDIT_CARD\",\r\n\t\t\"installments\":1,\r\n\t\t\"capture\":true,\r\n\t\t\"card\":{\r\n\t\t\t\"brand\":\"elo\",\r\n\t\t\t\"first_digits\":\"411111\",\r\n\t\t\t\"last_digits\":\"1111\",\r\n\t\t\t\"exp_month\":\"3\",\r\n\t\t\t\"exp_year\":\"2026\",\r\n\t\t\t\"holder\":{\r\n\t\t\t\t\"name\":\"Jose da Silva\"\r\n\t\t\t}\r\n\t\t},\r\n\t\t\"authentication_method\":{\r\n\t\t\t\"type\":\"INAPP\",\r\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\r\n\t\t\t\"eci\":\"04\"\r\n\t\t}\r\n\t},\r\n\t\"notification_urls\":[\r\n\t\t\r\n\t],\r\n\t\"metadata\":{\r\n\t\t\"Key\":\"value\"\r\n\t},\r\n\t\"links\":[\r\n\t\t{\r\n\t\t\t\"rel\":\"SELF\",\r\n\t\t\t\"href\":\"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\r\n\t\t\t\"media\":\"application/json\",\r\n\t\t\t\"type\":\"GET\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"rel\":\"CHARGE.CANCEL\",\r\n\t\t\t\"href\":\"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5/cancel\",\r\n\t\t\t\"media\":\"application/json\",\r\n\t\t\t\"type\":\"POST\"\r\n\t\t}\r\n\t]\r\n}"},{"id":"a2f4e990-0400-4933-940d-b8ba4de76060","name":"Cenário 4 - Charge - Token de Rede (Débito): ELO","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference_id\":\"ex-00001\",\n\t\"description\":\"Motivo da cobrança\",\n\t\"amount\":{\n\t\t\"value\":1000,\n\t\t\"currency\":\"BRL\"\n\t},\n\t\"payment_method\":{\n\t\t\"type\":\"DEBIT_CARD\",\n\t\t\"card\":{\n\t\t\t\"network_token\":\"4111111111111111\",\n\t\t\t\"exp_month\":\"03\",\n\t\t\t\"exp_year\":\"2026\",\n\t\t\t\"security_code\":\"123\",\n\t\t\t\"holder\":{\n\t\t\t\t\"name\":\"Jose da Silva\"\n\t\t\t}\n\t\t},\n\t\t\"authentication_method\":{\n\t\t\t\"type\":\"INAPP\",\n\t\t\t\"cavv\":\"BwABBylVaQAAAAFwllVpAAAAAAA=\",\n\t\t\t\"eci\":\"04\"\n\t\t}\n\t},\n\t\"notification_urls\":[\n\t\t\"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t],\n\t\"metadata\":{\n\t\t\"Exemplo\":\"Aceita qualquer informação\",\n\t\t\"NotaFiscal\":\"123\",\n\t\t\"idComprador\":\"123456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n \"reference_id\": \"ex-0001\",\n \"status\": \"PAID\",\n \"created_at\": \"2021-07-26T17:16:22.754-03:00\",\n \"paid_at\": \"2021-07-26T17:16:24.000-03:00\",\n \"description\": \"Motivo de cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"072638986091\"\n },\n \"payment_method\": {\n \"type\": \"DEBIT_CARD\",\n \"card\": {\n \"brand\": \"elo\",\n \"first_digits\": \"4111111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"3\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"José da Silva\"\n }\n },\n \"authentication_method\": {\n \"type\": \"INAPP\",\n \"eci\": \"4\",\n \"cavv\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA\"\n }\n },\n \"notification_urls\": [],\n \"metadata\": {\n \"Key\": \"value\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"http://charge-rest.charge-dockerized.aws/charges/CHAR_46466624-1B73-40DC-BFBE-6FD79A6B56A5/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"79a77144-148e-4327-bf51-cdb4d0d0b95d"},{"name":"Criando uma cobrança com Cartão Criptografado","event":[{"listen":"test","script":{"id":"58bf7da4-1f3b-4d4f-b53b-5884bcb10617","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r",""],"type":"text/javascript"}}],"id":"7584bfe6-29b8-44f1-8af0-bd6fb3308599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"encrypted\": \"cSx3NDmQ7QbSaqdtakrAO3yAgtMZMPPzF7jDai8k+13lj9dpbTloEDou4crYdB6TbWUiaE249EJTylKufMcooEtlZlJQInKoHA7/jnNw4V1HuhdCsWm+K653V6rhMDBx27t0YH68H8Zzh+zaywDp/JrG7HI/BdRmDfn2fLV+IegQ7+xJcT2st1cnawefdYbpmpJdtPS8fMB19CVIU5pkFj3ePHL1qoXAfD/cbLv0rgPCTldc4MRjIzYmORRdJ/4I/npsNnWSuTi7sP37GiJFtbbMO1bDKOLRpoKEITvzIpgIrMqiRUZG/60PNg3wPNwLR39Ymb11V60gIfUmjTJGuQ==\"\n }\n }\n}"},"url":"{{url}}/charges","description":"

Cobrando Cartão criptografado

Esse recurso permite que você realize cobranças com cartão de crédito em sua plataforma sem redirecionar o cliente ao ambiente do PagSeguro mantendo a experiência de compra em seu site.

1. Primeiro passo: Criptografar o cartão

Inclua o JavaScript PagSeguro em sua página, esse SDK disponibilizado irá possibilitar a criptografia dos dados sensíveis do cartão de crédito diretamente no navegador, reduzindo assim o seu escopo PCI.

O JavaScript PagSeguro não possui nenhuma operação que realize chamada em servidores, o tornando off-line, ou seja, um vez importado em sua página e baixado no navegador do cliente não irá requerer nenhuma comunicação externa para seu funcionamento.

Seu funcionamento é muito simples, através de sua chave pública é realizada uma criptografia usando algoritmo RSA, a string resulta no processo de criptografia poderá ser descriptografada apenas usando a chave privada (par da chave pública) que apenas o PagSeguro tem posse e é mantida de forma segura.

HTML

<script src=\"https://assets.pagseguro.com.br/checkout-sdk-js/rc/dist/browser/pagseguro.min.js\"></script>\n

Após incluir o JavaScript você deve configurar a chamada da função PagSeguro.encryptCard() passando a sua chave pública no parâmetro publicKey.

Os demais parâmetros da função são de uso para receber os dados sensíveis do cartão de crédito, como por exemplo:

holder - Nome completo do portador do cartão
number - Número do cartão de crédito
expMonth - Mês de expiração
expYear - Ano de expiração
securityCode - Código de segurança

JavaScript

var card = PagSeguro.encryptCard({\n  publicKey: \"MINHA_CHAVE_PUBLICA\",\n  holder: \"Nome Sobrenome\",\n  number: \"4242424242424242\",\n  expMonth: \"12\",\n  expYear: \"2030\",\n  securityCode: \"123\"\n});\n\nvar encrypted = card.encryptedCard;\n

Estrutura de objeto do cartão criptografado:

Ao utilizar o método encryptCard, sempre será gerado um objeto referente à criptografia realizada, contendo a seguinte estrutura:

encryptedCard: Cartão criptografado, que deve ser utilizado posteriormente para realizar cobranças
hasErrors: Determina se houve, ou não, algum erro durante o processo de criptografia
errors: Quando algum erro ocorrer, fornece uma lista com os erros relacionados, incluindo seu código e mensagem de erro.

Validação de dados para criptografia:

Na biblioteca JavaScript, erros ocorridos durante a criptografia são identificados com base na validação dos dados fornecidos.\nEstes são notificados com código e mensagem, e estão descritos abaixo:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código (code)	Mensagem (message)
INVALID_NUMBER	invalid card number
INVALID_SECURITY_CODE	invalid field securityCode. You must pass a value with 3, 4 or none digits
INVALID_EXPIRATION_MONTH	invalid field expMonth. You must pass a value between 1 and 12
INVALID_EXPIRATION_YEAR	invalid field expYear. You must pass a value with 4 digits
INVALID_PUBLIC_KEY	invalid publicKey
INVALID_HOLDER	invalid holder

","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2d117941-17be-4b0f-9006-dd2dad5107ce","name":"Cenário 1 - Charge - Cartão de Crédito Criptografado (sucesso)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"encrypted\": \"cSx3NDmQ7QbSaqdtakrAO3yAgtMZMPPzF7jDai8k+13lj9dpbTloEDou4crYdB6TbWUiaE249EJTylKufMcooEtlZlJQInKoHA7/jnNw4V1HuhdCsWm+K653V6rhMDBx27t0YH68H8Zzh+zaywDp/JrG7HI/BdRmDfn2fLV+IegQ7+xJcT2st1cnawefdYbpmpJdtPS8fMB19CVIU5pkFj3ePHL1qoXAfD/cbLv0rgPCTldc4MRjIzYmORRdJ/4I/npsNnWSuTi7sP37GiJFtbbMO1bDKOLRpoKEITvzIpgIrMqiRUZG/60PNg3wPNwLR39Ymb11V60gIfUmjTJGuQ==\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_344a0907-8aa6-4b7a-943c-897383adf45f\",\n \"reference_id\": \"76c35c0b-34d5-4ecc-af9d-3b2cecab033c\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-09-06T13:43:45.588-03:00\",\n \"paid_at\": \"2019-09-06T13:43:45.588-03:00\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1567788227697\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/344a0907-8aa6-4b7a-943c-897383adf45f\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/344a0907-8aa6-4b7a-943c-897383adf45f/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"notification_urls\": [],\n \"metadata\": {}\n}"},{"id":"342dd5f3-e432-488d-8721-0ecf7ecd8e40","name":"Cenário 2 - Charge - Cartão de Crédito Criptografado (negada)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"encrypted\": \"cSx3NDmQ7QbSaqdtakrAO3yAgtMZMPPzF7jDai8k+13lj9dpbTloEDou4crYdB6TbWUiaE249EJTylKufMcooEtlZlJQInKoHA7/jnNw4V1HuhdCsWm+K653V6rhMDBx27t0YH68H8Zzh+zaywDp/JrG7HI/BdRmDfn2fLV+IegQ7+xJcT2st1cnawefdYbpmpJdtPS8fMB19CVIU5pkFj3ePHL1qoXAfD/cbLv0rgPCTldc4MRjIzYmORRdJ/4I/npsNnWSuTi7sP37GiJFtbbMO1bDKOLRpoKEITvzIpgIrMqiRUZG/60PNg3wPNwLR39Ymb11V60gIfUmjTJGuQ==\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"DECLINED\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20001\",\n \"message\": \"CONTATE A CENTRAL DO SEU CARTÃO\",\n \"reference\": \"090400069049\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n }\n ]\n}"}],"_postman_id":"7584bfe6-29b8-44f1-8af0-bd6fb3308599"},{"name":"Criando uma cobrança para facilitadores de pagamentos (dados de sub-adquirente)","event":[{"listen":"test","script":{"id":"b42df43f-fe98-40bc-8b3f-7c7ec071faae","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r",""],"type":"text/javascript"}}],"id":"9afb827a-53cc-417c-91b3-35771e469228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"

Seu token de acesso para as APIs PagSeguro

\n","key":"Authorization","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"description":"

Chave de idempotência (opcional)

\n","key":"x-idempotency-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"MY-ID-09296126-6c89-46a5-9918-1b98118a5a0f\",\n \"description\": \"Motivo de pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"Loja da Maria\",\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"sub_merchant\": {\n \"reference_id\": \"MY-ID-dee56de2-2b70-4811-b0a0-60c6bd3ddbb4\",\n \"name\":\"Razão Social / Nome completo\",\n \"tax_id\": \"42167200803\",\n \"mcc\": \"155\",\n \"address\": {\n \"country\": \"BRA\",\n \"region_code\": \"SP\",\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"complement\": \"Apto 16\",\n },\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"98877887788\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}"},"url":"https://sandbox.api.pagseguro.com/charges","description":"

Por obrigatoriedade das bandeiras e do Banco Central, para atender os sub-adquirentes que queiram transacionar online, todas as transações enviadas devem conter informações adicionais que permitam a identificação do submerchant pela bandeira.

Com o objeto submerchant na API de Charge, permitimos a criação de uma cobrança de pagamento de um sub-adquirente, através desse método é possível utilizar apenas dados essenciais para efetivação de uma cobrança de acordo com o método de pagamento escolhido.

Métodos de pagamento disponíveis:

Cartão de Crédito

Atenção: Para começar a operar como sub-credenciador, é preciso que sua conta esteja habilitada para esta função. Procure o seu executivo comercial e solicite essa ativação.

Ponto Importante: Por padrão, MCCs de alto risco são bloqueados. Se o seu negócio realiza esse tipo de transação, é preciso informar ao seu executivo comercial para que suas transações sejam liberadas.

Objeto Sub-Lojista

Campo	Tipo	Presença	Descrição
└──`sub_merchant`	Object	`REQUEST: Condicional` `RESPONSE: Condicional`	Objeto contendo os dados do sub lojista, usado por sub-adquirentes para transações com cartão de crédito.
└──└──`reference_id`	String (15 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Identificador próprio referente ao lojista atribuído na plataforma do sub-adquirente.
└──└──`name`	String (60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Razão social do lojista na plataforma do sub-adquirente em caso de pessoa jurídica. Em casos de pessoa física, nome completo do lojista na plataforma do sub-adquirente.
└──└──`tax_id`	String (11 ou 14 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número do documento (CPF ou CNPJ) do lojista na plataforma do sub-adquirente. Apenas números devem ser informados (com ou sem máscara).
└──└──`mcc`	String (4 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código de atuação comercial do lojista na plataforma do sub-adquirente (merchant category code). Apenas números devem ser informados. Bloqueio padrão para casos de MCC de alto risco. Exemplos: 0763, 5199.
└──└──`address`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações de endereço do lojista na plataforma do sub-adquirente.
└──└──└──`street`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Rua do endereço do lojista na plataforma do sub-adquirente.
└──└──└──`number`	Int (1-20 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número do endereço do lojista na plataforma do sub-adquirente.
└──└──└──`complement`	String (1 - 40 caracteres)	`REQUEST: Opcional` `RESPONSE: Sim`	Número do apartamento, identificação de bloco.
└──└──└──`locality`	String (1-60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Bairro do endereço do lojista na plataforma do sub-adquirente.
└──└──└──`city`	String (1 - 60 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Cidade do endereço do lojista na plataforma do sub-adquirente.
└──└──└──`region_code`	String (2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do Estado do endereço do lojista na plataforma do sub-adquirente. Padrão ISO 3166-2.
└──└──└──`postal_code`	String (8 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	CEP do endereço do lojista na plataforma do sub-adquirente. Apenas números devem ser informados. Pode ser informado com ou sem máscara.
└──└──└──`country`	String (3 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país. No momento, apenas BRA é aceito.
└──└──`phones`	Object	`REQUEST: Opcional` `RESPONSE: Sim`	Objeto contendo uma lista de telefones de contato do lojista na plataforma do sub adquirente. É preciso ser informado para transações com a bandeira ELO.
└──└──└──`area`	Int (2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código DDD de telefone correspondente ao país. Atualmente, apenas o código para telefones brasileiros são permitidos. Exemplos: 11, 31,21, etc.
└──└──└──`country`	Int (2 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Código do país no telefone. Apenas telefones com DDI 55, código brasileiro, é válido.
└──└──└──`number`	Int (10 ou 11 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Número de celular válido. O número pode ser informado com ou sem máscara.
└──└──└──`type`	String (9 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Deve ser informado como: MOBILE.

","urlObject":{"protocol":"https","path":["charges"],"host":["sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"0cbc9e52-1d5a-408f-801f-47033f6df587","name":"Cenário 1 - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ID123456789\",\n \"description\": \"Motivo de pagamento\",\n \"amount\": {\n \"value\" : \"100\",\n \"currency\" : \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"LojaDoJoao\",\n \"card\": {\n \"number\": \"4916642720407380\",\n \"exp_month\": \"06\",\n \"exp_year\": \"2021\",\n \"security_code\": \"513\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"sub_merchant\": {\n \"name\": \"João Souza\",\n \"reference_id\": \"ID123456789\",\n \"tax_id\": \"12345678908\",\n \"mcc\": \"1554\",\n \"address\": {\n \"country\": \"BRA\",\n \"region_code\": \"SP\",\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"complement\": \"Apto 16\"\n },\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"911111111\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"notification_urls\": [\n \"https://webhookdojoao.com/\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_B29BD467-EB28-4DCE-927A-9DE0CEB36B84\",\n \"reference_id\": \"TesteGet2\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"2021-09-22T14:41:51.410-03:00\",\n \"description\": \"Motivo de pagamento\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 100,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"25700000700\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"capture_before\": \"2021-09-27T14:41:55.041-03:00\",\n \"card\": {\n \"brand\": \"visa\",\n \"first_digits\": \"491664\",\n \"last_digits\": \"7380\",\n \"exp_month\": \"6\",\n \"exp_year\": \"2021\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n },\n \"soft_descriptor\": \"OrcNaoSobreesc\"\n },\n \"sub_merchant\": {\n \"reference_id\": \"OrcSub\",\n \"name\": \"Felipe Olimpio\",\n \"tax_id\": \"12345678908\",\n \"mcc\": \"1554\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\",\n \"country\": \"BRA\",\n \"region_code\": \"SP\",\n \"complement\": \"Apto 16\"\n },\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"988778877\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"notification_urls\": [\n \"https://webhook.site/936a276f-16da-4766-af82-fcf19bc22232\"\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://charge-orchestrator.digital-payments.qa.aws.intranet.pagseguro.uol/charges/CHAR_B29BD467-EB28-4DCE-927A-9DE0CEB36B84\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://charge-orchestrator.digital-payments.qa.aws.intranet.pagseguro.uol/charges/CHAR_B29BD467-EB28-4DCE-927A-9DE0CEB36B84/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://charge-orchestrator.digital-payments.qa.aws.intranet.pagseguro.uol/charges/CHAR_B29BD467-EB28-4DCE-927A-9DE0CEB36B84/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}\n"},{"id":"bfaf587e-a330-4097-9784-2f5d2da6cc39","name":"Cenário 2 - Erro: Cliente não habilitado como sub-adquirente","originalRequest":{"method":"POST","header":[{"description":"Seu token de acesso para as APIs PagSeguro","key":"Authorization","type":"text","value":"{{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","type":"text","value":"application/json"},{"description":"Chave de idempotência (opcional)","key":"x-idempotency-key","type":"text","value":""},{"description":"Versão atual da API","key":"x-api-version","type":"text","value":"4.0"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"MY-ID-11e300c5-139b-426d-bbca-2c91f5ece976\",\n \"description\": \"Motivo de pagamento\" // Descrição da cobrança\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"soft_descriptor\": \"Nome na Fatura\",\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"sub_merchant\": {\n \"reference_id\": \"123456\",\n \"company_name\":\"Razão Social\",\n \"tax_id\": \"42167200803\",\n \"mcc\": \"155\",\n \"address\": {\n \"country\": \"Brasil\",\n \"region_code\": \"SP\",\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\"\n }\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"98877887788\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}"},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"error_messages\": [\r\n {\r\n \"code\": \"40001\",\r\n \"message\": \"sub_merchant is a mandatory field\",\r\n \"description\": \"required_parameter\",\r\n \"parameter_name\": \"sub_merchant\"\r\n }\r\n ]\r\n}"}],"_postman_id":"9afb827a-53cc-417c-91b3-35771e469228"},{"name":"Capturando uma cobrança","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(201);","});",""],"type":"text/javascript","id":"23ae6315-43e2-40f3-9a51-afa31bcfdb9f"}}],"id":"106bde75-4bc3-4a44-85dd-1780a55bfb8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-idempotency-key","value":"","description":"

Chave de idempotência (opcional)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": {\n \"value\": 1000\n }\n}"},"url":"{{url}}/charges/{{id}}/capture","description":"

Através desse recurso você poderá realizar a captura de uma cobrança criada inicialmente no cenário de cobrança em duas etapas.
\n
\nEsse recurso é ideal para quem\n

Esse modelo é indicado para operações mais complexas ou que requerem confirmação/ validação de alguma outra parte/ sistema antes de efetivar a cobrança no cartão de crédito. Como por exemplo, confirmação de estoque disponível.

Detalhes\n

Ao autorizar uma cobrança a mesma ficará disponível para captura por até 5 dias corridos. Caso não haja solicitação de captura, no 6º dia o PagSeguro fará o cancelamento da cobrança automaticamente.
A captura poderá ser feita no valor total ou parcial da autorização.
A captura poderá ser feita apenas se a cobrança estiver com status autorizada (AUTHORIZED).

\n","urlObject":{"path":["charges","{{id}}","capture"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d37b52bb-bb77-4ff3-b064-81b6e3afc37e","name":"Cenário 1 - Capture (valor total)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/capture"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"paid_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"070177181003\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"expiry_month\": \"03\",\n \"expiry_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/captures\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.REFUND\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/refunds\",\n \"method\": \"POST\"\n }\n ]\n}"},{"id":"76ad90ba-5002-407d-8f3c-82155483ab6a","name":"Cenário 2 - Capture (valor parcial)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": {\r\n \"value\": 500\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/capture"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"paid_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"070177181003\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"expiry_month\": \"03\",\n \"expiry_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/captures\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.REFUND\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/refunds\",\n \"method\": \"POST\"\n }\n ]\n}"}],"_postman_id":"106bde75-4bc3-4a44-85dd-1780a55bfb8f"},{"name":"Reembolsando uma cobrança","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"924b6609-dbc1-433e-be47-4a982606b1f9"}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});",""],"type":"text/javascript","id":"a7dd9c9f-d867-42a5-9d50-5cc94c794eed"}}],"id":"daaad378-c371-43a6-a505-91ddeb81c8f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"

Versão atual da API

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": {\n \"value\": 500\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges/{{id}}/cancel","description":"

Através desse recurso devolva o valor pago ao comprador, tanto para desfazer uma pré-autorização ou reembolsar um pagamento capturado.

Esse recurso é ideal para quem

Teve algum desacordo comercial e precisa devolver o valor pago ao comprador.

Os cenários disponíveis para devolução/reembolso são:

Cartão de Crédito

Cobranças nos seguintes status:

AUTHORIZED
PAID

Boleto e Pix

Cobranças nos seguintes status:

PAID

Detalhes

A devolução da cobrança pode ser integral ou parcial e mais de uma vez até completar o valor total.
Prazo máximo de 350 dias para devolução de uma cobrança com cartão de crédito e boleto e 90 dias para devolução de uma cobrança com Pix ambas após a autorização.
A devolução de uma cobrança paga com cartão de crédito será reembolsado nas próximas faturas de cartão.
A devolução de uma cobrança paga com boleto será feita de forma a creditar saldo em conta PagSeguro. O prazo máximo para que o valor esteja em conta PagSeguro é de até 2 dias úteis.
A devolução de uma cobrança paga com Pix será estornada na conta utilizada para o pagamento.
Ao realizar uma devolução do valor parcial da cobrança o status não será alterado, ele permanecera com status de Pago (PAID).
Utilize o parâmetro amount.summary.refunded para confirmar o valor que foi devolvido ao comprador.

\n","urlObject":{"path":["charges","{{id}}","cancel"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"546e9cc6-d2c7-4e25-8034-6a3a19058ebd","name":"Cenário 1 - Cancel (valor total)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": {\n \"value\": 1000\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"CANCELED\",\n \"created_at\": \"2019-08-21T15:14:58.121-03:00\",\n \"paid_at\": \"2019-08-21T15:14:58.121-03:00\",\n \"description\": \"Motivo da cobranca\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 1000\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1566411299393\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [],\n \"notification_urls\": [\n \"https://api.runscope.com/radar/inbound/f9e7bcbd-50dc-4821-8959-9854796d01c3\"\n ],\n \"metadata\": {}\n}"},{"id":"6e4f322e-8795-424c-a715-3a39e2171bec","name":"Cenário 2 - Cancel (valor parcial)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": {\n \"value\": 500\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-08-21T15:14:58.121-03:00\",\n \"paid_at\": \"2019-08-21T15:14:58.121-03:00\",\n \"description\": \"Motivo da cobranca\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 500\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1566411299393\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [],\n \"notification_urls\": [\n \"https://api.runscope.com/radar/inbound/f9e7bcbd-50dc-4821-8959-9854796d01c3\"\n ],\n \"metadata\": {}\n}"}],"_postman_id":"daaad378-c371-43a6-a505-91ddeb81c8f9"},{"name":"Cobrando com indicação de recorrência","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"reference_id\", jsonData.reference_id);\r","postman.setEnvironmentVariable(\"id\", jsonData.id);\r","\r","pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r",""],"type":"text/javascript","id":"b8d33afb-902c-4160-bc58-b091c812c645"}}],"id":"16725263-60cf-42a7-89d2-e991c73d5862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"

Seu token de acesso para as APIs PagSeguro

\n","key":"Authorization","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"description":"

Chave de idempotência (opcional)

\n","key":"x-idempotency-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": \"1\",\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"João da silva\"\n }\n }\n },\n \"recurring\": {\n \"type\": \"INITIAL\"\n },\n \"notification_urls\": [\n \"https://yourserver.com/ecommerce/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}"},"url":"{{url}}/charges","description":"

Através desse recurso realize uma cobrança do seu cliente, indicando ao PagSeguro que a cobrança está relacionada a um pagamento recorrente.
\n

Esse recurso é ideal se você\n

Possui serviço contínuo;
Possui gestão de recorrência própria;

Criar uma cobrança indicando recorrência\n

Para a primeira cobrança da recorrencia, você deve integrar seu sistema com a API de Cobrança usando o recurso /charges informando o tipo de recorrência INITIAL no parâmetro recurring.type.\n
\n
\nJá para as cobranças subsequentes, você deve integrar seu sistema com a API de Cobrança usando o recurso /charges informando o tipo de recorrência SUBSEQUENT no parâmetro recurring.type.\n
\n
\nImportante: A utilização desse parâmetro não está vinculada nem condicionada à API de Pagamento Recorrente do PagSeguro.

\n","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"73e4dcee-bcf8-4440-a5cb-6d676ea289e3","name":"Criando uma cobrança com indicação de recorrência (cobrança inicial) com sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"},{"key":"x-idempotency-key","value":"","description":"Chave de idempotência (opcional)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo do pagamento\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"recurring\": {\n \"type\": \"INITIAL\"\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Aceita qualquer informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1\",\r\n \"reference_id\": \"ex-00001\",\r\n \"status\": \"PAID\",\r\n \"created_at\": \"2020-05-19T18:49:48.406-03:00\",\r\n \"paid_at\": \"2020-05-19T18:49:48.45-03:00\",\r\n \"description\": \"Motivo da cobrança\",\r\n \"amount\": {\r\n \"value\": 1000,\r\n \"currency\": \"BRL\",\r\n \"summary\": {\r\n \"total\": 1000,\r\n \"paid\": 1000,\r\n \"refunded\": 0\r\n }\r\n },\r\n \"payment_response\": {\r\n \"code\": \"20000\",\r\n \"message\": \"SUCESSO\",\r\n \"reference\": \"031700056475\"\r\n },\r\n \"payment_method\": {\r\n \"type\": \"CREDIT_CARD\",\r\n \"installments\": 1,\r\n \"capture\": true,\r\n \"card\": {\r\n \"brand\": \"mastercard\",\r\n \"first_digits\": \"411111\",\r\n \"last_digits\": \"1111\",\r\n \"exp_month\": \"3\",\r\n \"exp_year\": \"2026\",\r\n \"holder\": {\r\n \"name\": \"João da silva\"\r\n }\r\n }\r\n },\r\n \"recurring\": {\r\n \"type\": \"INITIAL\"\r\n },\r\n \"links\": [\r\n {\r\n \"rel\": \"SELF\",\r\n \"href\": \"https://api.pagseguro.com/charges/CHAR_80ffd68a-a74e-4066-b35c-076c467f35b1\",\r\n \"media\": \"application/json\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CHARGE.CANCEL\",\r\n \"href\": \"https://api.pagseguro.com/charges/CHAR_80ffd68a-a74e-4066-b35c-076c467f35b1/cancel\",\r\n \"media\": \"application/json\",\r\n \"type\": \"POST\"\r\n }\r\n ],\r\n \"notification_urls\": [\r\n \"https://yourserver.com/ecommerce/\"\r\n ],\r\n \"metadata\": {\r\n \"Exemplo\": \"Informação\",\r\n \"NotaFiscal\": \"123\",\r\n \"idComprador\": \"123456\"\r\n }\r\n}"},{"id":"82757b69-c4e0-41f6-8961-c4f57bd1f877","name":"Criando uma cobrança com indicação de recorrência (cobranças subsequentes) com sucesso","originalRequest":{"method":"POST","header":[{"description":"Seu token de acesso para as APIs PagSeguro","key":"Authorization","type":"text","value":"{{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"Chave de idempotência (opcional)","key":"x-idempotency-key","type":"text","value":""},{"description":"Versão atual da API","key":"x-api-version","type":"text","value":"4.0"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": \"1\",\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"João da silva\"\n }\n }\n },\n \"recurring\": {\n \"type\": \"SUBSEQUENT\"\n },\n \"notification_urls\": [\n \"https://yourserver.com/ecommerce/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/charges"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-05-19T18:49:48.406-03:00\",\n \"paid_at\": \"2020-05-19T18:49:48.45-03:00\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 1000,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"031700056475\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"mastercard\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"3\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"João da silva\"\n }\n }\n },\n \"recurring\": {\n \"type\": \"SUBSEQUENT\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_80ffd68a-a74e-4066-b35c-076c467f35b1\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://api.pagseguro.com/charges/CHAR_80ffd68a-a74e-4066-b35c-076c467f35b1/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"notification_urls\": [\n \"https://yourserver.com/ecommerce/\"\n ],\n \"metadata\": {\n \"Exemplo\": \"Informação\",\n \"NotaFiscal\": \"123\",\n \"idComprador\": \"123456\"\n }\n}"}],"_postman_id":"16725263-60cf-42a7-89d2-e991c73d5862"},{"name":"Consultando uma Cobrança","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"d271f6ad-1780-461c-938f-193f07299658"}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","id":"49044b57-6d06-49da-8ceb-0e894121813e"}}],"id":"0f1d0309-477f-4a9c-9807-d2ceb049380a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

Seu token de acesso para as APIs PagSeguro

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/charges/{{charge_id}}","description":"

Realizando a Consulta de uma cobrança

Recurso destinado há consulta de uma cobrança(transações de pagamento) já criada.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Obrigatoriedade	Descrição
id	String (41 caracteres)	Obrigatório	Identifcador PagSeguro da cobrança.

","urlObject":{"path":["charges","{{charge_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d1cecb09-e05d-46f0-9663-b54333486d3a","name":"O customer não foi localizado.","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","type":"text","value":"","description":"TOKEN"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"url":"{{url}}/charges/{{id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"error_messages\": [\r\n {\r\n \"code\": \"string\",\r\n \"description\": \"string\",\r\n \"errors\": [\r\n \"string\"\r\n ],\r\n \"parameter_name\": \"string\"\r\n }\r\n ]\r\n}\r\n\r\n"},{"id":"7d1f72a9-e170-4ca0-9572-6c44c8e9aea3","name":"Consultando uma Cobraça","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"url":"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": 20000,\n \"message\": \"SUCESSO\",\n \"reference\": \"071200027526\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": false,\n \"card\": {\n \"brand\": \"VISA\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"03\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_erp/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"0f1d0309-477f-4a9c-9807-d2ceb049380a"},{"name":"Buscando uma Cobrança","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"4e049d5c-b9ad-4225-96f6-1e48f2414b64"}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","id":"8d69a898-d301-48e5-9cf1-ffb79294c223"}}],"id":"150f0baf-0638-4283-8951-3564b77114c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"

TOKEN

\n","key":"Authorization","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/charges?reference_id={{reference_id}}","description":"

Realizando a Consulta de uma cobrança
\nRecurso destinado há busca de uma cobrança(transações de pagamento) já criada usando a referencia fornecida por você.

Utilizando esse recurso você poderá sempre que necessário recuperar alguma informação da cobrança ou consultar o status mais atual da sua cobrança.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Obrigatoriedade	Descrição
reference_id	String	Obrigatório	Referência fornecida pelo integrador

","urlObject":{"path":["charges"],"host":["{{url}}"],"query":[{"key":"reference_id","value":"{{reference_id}}"}],"variable":[]}},"response":[{"id":"0d2c02cc-1bac-4b80-bf96-fa8bf6e68bc6","name":"Buscando uma Cobraça","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","description":"Seu token de acesso para as APIs PagSeguro","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-version","value":"4.0","description":"Versão atual da API","type":"text"}],"url":{"raw":"https://sandbox.api.pagseguro.com/charges?reference_id=ex-00001","protocol":"https","host":["sandbox","api","pagseguro","com"],"path":["charges"],"query":[{"key":"reference_id","value":"ex-00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n\t \"reference_id\": \"ex-00001\",\n\t \"status\": \"AUTHORIZED\",\n\t \"created_at\": \"2019-04-17T20:07:07.002-02\",\n\t \"description\": \"Motivo da cobrança\",\n\t \"amount\": {\n\t \"value\": 1000,\n\t \"currency\": \"BRL\",\n\t \"summary\": {\n\t \"total\": 1000,\n\t \"paid\": 0,\n\t \"refunded\": 0\n\t }\n\t },\n\t \"payment_response\": {\n\t \"code\": 20000,\n\t \"message\": \"SUCESSO\",\n\t \"reference\": \"071200027526\"\n\t },\n\t \"payment_method\": {\n\t \"type\": \"CREDIT_CARD\",\n\t \"installments\": 1,\n\t \"capture\": false,\n\t \"card\": {\n\t \"brand\": \"VISA\",\n\t \"first_digits\": \"411111\",\n\t \"last_digits\": \"1111\",\n\t \"exp_month\": \"03\",\n\t \"exp_year\": \"2026\",\n\t \"holder\": {\n\t \"name\": \"Jose da Silva\"\n\t }\n\t }\n\t },\n\t \"notification_urls\": [\n\t \"https://yourserver.com/nas_erp/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n\t ],\n\t \"links\": [\n\t {\n\t \"rel\": \"SELF\",\n\t \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n\t \"media\": \"application/json\",\n\t \"type\": \"GET\"\n\t },\n\t {\n\t \"rel\": \"CHARGE.CAPTURE\",\n\t \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/capture\",\n\t \"media\": \"application/json\",\n\t \"type\": \"POST\"\n\t },\n\t {\n\t \"rel\": \"CHARGE.CANCEL\",\n\t \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel\",\n\t \"media\": \"application/json\",\n\t \"type\": \"POST\"\n\t }\n\t ]\n\t}\t\n]"}],"_postman_id":"150f0baf-0638-4283-8951-3564b77114c5"},{"name":"Recebendo uma notificação de uma cobrança","id":"7b9cc806-a57c-442a-99a1-305e90379467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://meusite.com/notificacoes","description":"

O PagSeguro poderá enviar notificações via webhook para seu ambiente sempre que um evento (uma mudança de status de transação) acontecer, possibilitando a automação de seus processos de gestão de vendas.

Configurando o recebimento de notificação

Para receber notificações via webhook utilizando a API de Cobrança é necessário enviar no payload da cobrança o campo opcional notification_urls. Assim, sempre que ocorrer um evento nessa transação o PagSeguro enviará as notificações para a URL de destino (método POST).

Eventos transacionais

Para os eventos transacionais você receberá o conteúdo da notificação direto em sua aplicação onde a estrutura das informações será idêntica a estrutura de um response ou quando você realizar uma consulta no recurso em questão.

Veja a ilustração desse fluxo abaixo:\n $\"Eventos$

Cartão de crédito

AUTHORIZED
PAID
DECLINED
CANCELED

Boleto bancário

WAITING
PAID
CANCELED

Eventos pós-transacionais

Para as notificações pós-transacionais usamos uma abordagem diferente do mencionado acima, nesse cenário você será notificado com um identificador de operação, em mãos desse identificador você deverá fazer uma consulta no PagSeguro para recuperar o conteúdo da notificação em si.

Veja a ilustração desse fluxo abaixo:\n $\"Eventos$

Mudanças de status

1 - Aguardando pagamento
2 - Em análise
3 - Paga
4 - Disponível
5 - Em disputa
6 - Devolvida
7 - Cancelada
8 - Debitado
9 - Retenção temporária

Atenção: veja com mais detalhes de como essa notificação funciona aqui.

\n","urlObject":{"protocol":"https","path":["notificacoes"],"host":["meusite","com"],"query":[],"variable":[]}},"response":[{"id":"3d15d596-868e-43a9-af83-458cde6e39a1","name":"2. Evento pós-transacional: Charge disponível","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"notificationCode","value":"766B9C-AD4B044B04DA-77742F5FA653-E1AB24","description":"Identificador PagSeguro da operação","type":"text"},{"key":"notificationType","value":"transaction","description":"Tipo de operação","type":"text"}]},"url":"https://meusite.com/notificacoes"},"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":null},{"id":"9707214d-ba52-4fad-9949-9136fa19d4e6","name":"1. Evento transacional: Charge paga","originalRequest":{"method":"POST","header":[],"url":"https://meusite.com/notificacoes"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CHAR_992582af-febf-44fb-994b-81cd00b743b0\",\n \"reference_id\": \"ref0001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"paid_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"description\": \"Pagamento de teste\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"MASTERCARD\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"02\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Nome Sobrenome\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"metadata\": {}\n}"}],"_postman_id":"7b9cc806-a57c-442a-99a1-305e90379467"},{"name":"Consultando uma notificação pós-transacional","id":"461def42-87e9-4f17-830c-6088d52a6c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://ws.pagseguro.uol.com.br/v3/transactions/notifications/{{notificationCode}}?email={{email_conta_pagseguro}}&token={{token}}","description":"

Exemplo do contéudo de uma notificação pós-transacional recuperada por você no serviço do PagSeguro.

Veja o detalhamento de cada parâmetro nessa outra sessão que preparamos para você .

\n","urlObject":{"protocol":"https","path":["v3","transactions","notifications","{{notificationCode}}"],"host":["ws","pagseguro","uol","com","br"],"query":[{"description":{"content":"

E-mail principal cadastrado em sua cionta PagSeguro

\n","type":"text/plain"},"key":"email","value":"{{email_conta_pagseguro}}"},{"description":{"content":"

Token de API referente a sua conta PagSeguro

\n","type":"text/plain"},"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9fdf45ff-c257-4d74-85c6-dba7c87e1197","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"url":{"raw":"https://ws.pagseguro.uol.com.br/v3/transactions/notifications/766B9C-AD4B044B04DA-77742F5FA653-E1AB24\n?email=email-lojista@seusite.com.br&token={{token_api}}","protocol":"https","host":["ws","pagseguro","uol","com","br"],"path":["v3","transactions","notifications","766B9C-AD4B044B04DA-77742F5FA653-E1AB24\n"],"query":[{"key":"email","value":"email-lojista@seusite.com.br","description":"E-mail principal cadastrado em sua cionta PagSeguro"},{"key":"token","value":"{{token_api}}","description":"Token de API referente a sua conta PagSeguro"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n 2019-08-19T18:10:02.000-03:00\n 992582AF-FEBF-44FB-994B-81CD00B743B0\n 1\n 4\n 2019-09-18T03:31:52.000-03:00\n \n 1\n 102\n \n 5.00\n 0.00\n \n 0.00\n 0.40\n 0.20\n \n 4.40\n 0.00\n 2019-09-18T01:00:00.000-03:00\n 1\n 1\n \n \n 1\n Web\n 1\n 5.00\n \n \n \n PUB********************************\n \n"}],"_postman_id":"461def42-87e9-4f17-830c-6088d52a6c73"}],"id":"46599cc1-4f6e-473b-87e9-887219480924","description":"

Parâmetros de Requisição

O Recurso cobrança (Charge) em sua definição representa a criação de cobrança de valor através de um meio de pagamento, contendo informações necessárias exclusivamente para esse fim. De acordo com a forma de pagamento escolhida pode ser necessário informar mais ou menos dados.

Atualmente a cobrança pode ser realizada com as seguintes formas de pagamento:

Cartão de Crédito
Cartão de Débito (Obrigatório 3DS)
Boleto Bancário

\n","event":[{"listen":"prerequest","script":{"id":"82f622b2-6b9b-4922-acc1-0b0613cc8148","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a011e61c-b670-4886-b99f-040e41fbda70","type":"text/javascript","exec":[""]}}],"_postman_id":"46599cc1-4f6e-473b-87e9-887219480924"},{"name":"Orders","item":[{"name":"Objeto Pedido","id":"8337bf1d-e2e3-44e5-8216-08a11ad3c275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/orders","description":"

O recurso Pedido (Orders), em sua definição, representa o fechamento do carrinho de compras, contendo informações que identifique o que está sendo adquirido, o comprador, endereço de entrega e demais informações relevantes. Caso a análise de risco esteja habilitada, esses dados serão essenciais para uma maior taxa de aprovação.

Requisição

Campo	Tipo	Presença	Descrição
`id`	String (41 caracteres)	`REQUEST:Não` `RESPONSE:Sim`	Identificador do pedido PagSeguro
`reference_id`	String (1-200 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Identificador próprio atribuído para o pedido
`customer`	Object	`REQUEST:Obrigatório` `RESPONSE:Sim`	Objeto contendo as informações do comprador
└──`name`	String (1-30 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Nome do comprador
└──`email`	String (10-255 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	E-mail do comprador
└──`tax_id`	String (11/14 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Documento do comprador (CPF/CNPJ)
└──`phone`	Array of Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo os telefones do comprador
└──└──`country`	Int (3 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Código de operadora do País (DDI)
└──└──`area`	Int (2 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Código de operadora local (DDD)
└──└──`number`	Int (8-9 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Número de telefone
└──└──`type`	String (ENUM)	`REQUEST:Opcional` `RESPONSE:Condicional`	Indica o tipo de telefone. - `CELLPHONE` Se for um telefone celular. - `BUSINESS` Se for um telefone comercial.
`items`	Array of Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo as informações dos itens inseridos no pedido
└──`name`	String (1-64 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Nome dado ao item
└──`quantity`	`Int (5 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	Quantidade referente ao item
└──`unit_amount`	`Int (9 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	Valor do item
`shipping`	Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo as informações de entrega do pedido
└──`address`	Object	`REQUEST:Obrigatório` `RESPONSE:Sim`	Objeto contendo as informações de endereço de entrega do pedido.
└──└──`street`	String (1-160 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Rua do endereço de entrega do pedido
└──└──`number`	String (1-20 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Número do endereço de entrega do pedido
└──└──`complement`	String (1-40 caracteres)	`REQUEST:Opcional` `RESPONSE:Condicional`	Complemento do endereço de entrega do pedido
└──└──`locality`	String (1-60 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Bairro do endereço de entrega do pedido
└──└──`city`	String (1-90 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Cidade do endereço de entrega do pedido
└──└──`region_code`	String (3 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Código do Estado do endereço de entrega do pedido. Padrão ISO 3166-2
└──└──`country`	String (1-50 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	País do endereço de entrega do pedido
└──└──`postal_code`	String (8 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	CEP do endereço de entrega do pedido
`qr_codes`	Array of Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo os QR Codes vinculados à um pedido. Ao informar o `amount`, o QR code será gerado automaticamente e pode ser pago com o app PagBank (saldo e cartão de crédito) ou com aplicativos de outras instituições (Pix). Para que o QR Code aceite o pagamento Pix, o vendedor precisa ter pelo menos uma chave de endereçamento ativa vinculada a sua conta PagBank. Caso o vendedor tenha mais de uma chave de endereçamento cadastrada no PagSeguro, priorizaremos a utilização da chave de endereçamento aleatória. O QR Code gerado aceita apenas um pagamento aprovado, ou seja, após uma tentativa de pagamento concluída com sucesso usando o QR Code, o mesmo não receberá outros pagamentos. Por enquanto, só é possível ter um QR Code por pedido.
└──`amount`	Object	`REQUEST:Obrigatório` `RESPONSE:Sim`	Objeto contendo as informações do valor a ser utilizado no QR Code
└──└──`value`	Int (5 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Valor do QR Code
`notification_urls`	Array of Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo as urls que receberão as notificações do pedido (por ora, somente aceitamos uma url apenas. Aceitamos mais urls em breve.)
`charges`	Array of Object	`REQUEST:Opcional` `RESPONSE:Condicional`	Objeto contendo cobranças. Veja detalhes do recurso Cobrança aqui.
`links`	Array of Object	`REQUEST:Não` `RESPONSE:Sim`	Objeto contendo links relacionados ao recurso
└──`rel`	String (ENUM)	`REQUEST:Não` `RESPONSE:Sim`	Indica o tipo do relacionamento ao recurso
└──`href`	String (5-2048 caracteres)	`REQUEST:Não` `RESPONSE:Sim`	Endereço HTTP do recurso.
└──`media`	String (11-64 caracteres)	`REQUEST:Não` `RESPONSE:Sim`	Tipo de mídia ao qual o link responde ou aceita. - `application/json` - `application/pdf` - `application/image`
└──`type`	String (ENUM)	`REQUEST:Não` `RESPONSE:Sim`	Método HTTP em uso. - `GET` - `POST` - `DELETE` - `PUT`

","urlObject":{"path":["orders"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8337bf1d-e2e3-44e5-8216-08a11ad3c275"},{"name":"Criando um Pedido","id":"11816a25-fffa-4410-9cfd-b51932ddc9db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"reference_id\": \"referencia do item\",\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 1\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 100\r\n }\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}"},"url":"{{url}}/orders","description":"

Através desse endpoint é possível criar um pedido que será pago posteriormente.

\n","urlObject":{"path":["orders"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"42e512b6-5c08-4720-ab80-2f8ba9ca256d","name":"Criando um pedido com sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{token_api}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"reference_id\": \"referencia do item\",\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 500\r\n }\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [],\n \"qr_codes\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"11816a25-fffa-4410-9cfd-b51932ddc9db"},{"name":"Consultar um pedido","id":"12ca0fe3-059a-45ba-b394-a36366082e19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/orders/ORDER-ID","description":"

Através desse endpoint, você poderá consultar pedidos previamente criados.

\n","urlObject":{"path":["orders","ORDER-ID"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"36665fbb-c19a-43d8-b10e-635fad6b74f8","name":"Consultando um pedido com sucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token_api}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/orders/ORDER-ID"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500,\n \"dimensions\": {\n \"length\": 12,\n \"width\": 34,\n \"height\": 32\n },\n \"weight\": 100\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"+55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [],\n \"qr_code\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"12ca0fe3-059a-45ba-b394-a36366082e19"},{"name":"Pagando um Pedido","id":"1ff78f8a-2cb1-4cff-a0b2-bfc686f3eb13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charges\": [\n {\n \"reference_id\": \"referencia da cobranca\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n },\n \"store\": false\n }\n },\n \"metadata\": {\n \"Key\": \"value\"\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ]\n }\n ]\n}"},"url":"{{url}}/orders/ORDER-ID/pay","description":"

Use esse endpoint para realizar cobranças de um pedido previamente criado.

\n","urlObject":{"path":["orders","ORDER-ID","pay"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"bf0bc51d-6893-463d-89f5-b3a8de883dd9","name":"Pagando um pedido com sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_api}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"charges\": [\n {\n \"reference_id\": \"referencia do pagamento\",\n \"description\": \"descricao do pagamento\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n },\n \"store\": false\n }\n },\n \"metadata\": {\n \"Key\": \"value\"\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders/ORDER-ID/pay"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500,\n \"dimensions\": {\n \"length\": 12,\n \"width\": 34,\n \"height\": 32\n },\n \"weight\": 100\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"+55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [\n {\n \"id\": \"CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"reference_id\": \"referencia da cobranca\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-11-21T23:30:22.695-03:00\",\n \"paid_at\": \"2020-11-21T23:30:24.352-03:00\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1606012224352\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"visa\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"metadata\": {\n \"Key\": \"value\"\n }\n }\n ],\n \"qr_code\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"1ff78f8a-2cb1-4cff-a0b2-bfc686f3eb13"},{"name":"Criando e pagando um pedido","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"2c84a07c-3b3e-4837-a889-1692c41d1993"}}],"id":"ccc5f1ce-1840-46c7-b58d-b57a492e9f8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"qr_codes\": [\n {\n \"amount\": {\n \"value\": 500\n }\n }\n ],\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ],\n \"charges\": [\n {\n \"reference_id\": \"referencia da cobranca\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n },\n \"store\": false\n }\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ]\n }\n ]\n}"},"url":"{{url}}/orders","description":"

Através desse recurso é possível criar um pedido já realizando a cobrança em um único passo.

\n","urlObject":{"path":["orders"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2d700057-751a-49e4-b891-49aa97185347","name":"Pedido criado e cobrança paga ","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{token_api}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ex-00001\",\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"qr_code\": {\n \"amount\": {\n \"value\": 500\n }\n },\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ],\n \"charges\": [\n {\n \"reference_id\": \"referencia do pagamento\",\n \"description\": \"descricao do pagamento\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"security_code\": \"123\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n },\n \"store\": false\n }\n },\n \"notification_urls\": [\n \"https://meusite.com/notificacoes\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:12:23.28-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [\n {\n \"id\": \"CHAR_3D4C63B5-B71E-418B-891E-660C79348C65\",\n \"reference_id\": \"referencia da cobranca\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-11-21T23:12:25.114-03:00\",\n \"paid_at\": \"2020-11-21T23:12:25.737-03:00\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1606011145716\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"visa\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_3D4C63B5-B71E-418B-891E-660C79348C65\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_3D4C63B5-B71E-418B-891E-660C79348C65/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n }\n ],\n \"qr_codes\": [\n {\n \"id\": \"QRCO_AAA10C0A-4316-4C9C-A3CF-288E304BBC8A\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO0136AAA10C0A-4316-4C9C-A3CF-288E304BBC8A52048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049BA1\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_AAA10C0A-4316-4C9C-A3CF-288E304BBC8A/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_AAA10C0A-4316-4C9C-A3CF-288E304BBC8A/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"ccc5f1ce-1840-46c7-b58d-b57a492e9f8c"},{"name":"Criando um pedido com QR Code (PIX ou PagBank)","id":"bfc52c5b-2829-4e30-b7a0-711cf883e5f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 500\r\n },\r\n \"expiration_date\": \"2021-08-29T20:15:59-03:00\"\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders","description":"

Através desse endpoint é possível criar um pedido com QR Code.
\nO QR Code gerado pelo order pode ser pago via PIX ou app Pagbank.\n

\nAo informar um valor no objeto qr_codes, o QR code será gerado automaticamente e pode ser pago com o app PagBank (saldo e cartão de crédito) ou com aplicativos de outras instituições (PIX).
Por padrão o QR code gerado tem validade de 24 horas.\n

\nPara que o QR Code aceite o pagamento PIX, o vendedor precisa ter pelo menos uma chave de endereçamento ativa vinculada a sua conta PagBank. Caso o vendedor tenha mais de uma chave de endereçamento cadastrada no PagSeguro, priorizaremos a utilização da chave de endereçamento aleatória.\n

\nO QR Code gerado aceita apenas um pagamento aprovado, ou seja, após uma tentativa de pagamento concluída com sucesso usando o QR Code, o mesmo não receberá outros pagamentos. Por enquanto, só é possível ter um QR Code por pedido.\n

Objeto qr_codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`qr_codes`	Array of Object	`REQUEST: Opcional` `RESPONSE: Condicional`	Objeto contendo os QR Codes vinculados à um pedido.
└──`amount`	Object	`REQUEST: Obrigatório` `RESPONSE: Sim`	Objeto contendo as informações do valor a ser utilizado no QR Code
└──└──`value`	Int (5 caracteres)	`REQUEST: Obrigatório` `RESPONSE: Sim`	Valor do QR Code
└──`expiration_date`	String Formato esperado: ISO-8601, `YYYY-MM-DDThh:mm:ssTZD`	`REQUEST: Opcional` `RESPONSE: Sim`	Objeto contendo a data de expiração do QR Code. Esta data é válida apenas para os QR Codes PIX. Obs: Se a data não for informada, o QR Code PIX será válido para receber pagamentos até às 23:59:59h do próximo dia corrido. O prazo máximo de expiração aceito é de 180 dias a partir da data de criação.

","urlObject":{"path":["orders"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"313f2ec6-43fb-4e7b-9093-2f9236ca831e","name":"Pedido com QR Code (PIX ou PagBank) criado com sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 500\r\n }\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders"},"status":"- Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_9BBD677F-863E-4D46-BAAF-2EECEE49FF31\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2021-01-19T09:30:12.197-03:00\",\n \"customer\": {\n \"name\": \"José da Silva\",\n \"email\": \"jose@email.com\",\n \"tax_id\": \"12345678901\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": \"1\",\n \"unit_amount\": \"100\"\n }\n ],\n \"amount\": {\n \"currency\": \"BRL\",\n \"additional\": 100,\n \"discount\": 100\n },\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"qr_codes\": [\n {\n \"id\": \"QRCO_9E13BFE1-35C3-4DFD-B499-9B110AC0E1BA\",\n \"expiration_date\": \"2021-08-29T20:15:59-03:00\",\n \"amount\": {\n \"value\": 100\n },\n \"text\": \"00020101021226830014br.gov.bcb.pix2561api.pagseguro.com/pix/v2/9E13BFE1-35C3-4DFD-B499-9B110AC0E1BA27600016BR.COM.PAGSEGURO01369E13BFE1-35C3-4DFD-B499-9B110AC0E1BA52045697530398654041.005802BR5925Leticia Oliveira Porto La6007Barueri62070503***6304658F\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://api.pagseguro.com/qrcode/QRCO_9E13BFE1-35C3-4DFD-B499-9B110AC0E1BA/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://api.pagseguro.com/qrcode/QRCO_9E13BFE1-35C3-4DFD-B499-9B110AC0E1BA/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"charges\": [],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/orders/ORDE_9BBD677F-863E-4D46-BAAF-2EECEE49FF31\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://api.pagseguro.com/orders/ORDE_9BBD677F-863E-4D46-BAAF-2EECEE49FF31/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"},{"id":"bd98913f-fe9e-40bc-a077-ffe7f1537285","name":"Erro - Pedido com QR Code (PIX ou PagBank) data de expiração vencida","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 500\r\n }\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40002\",\n \"description\": \"must be a future date\",\n \"parameter_name\": \"qr_codes[0].expiration_date\"\n }\n ]\n}"},{"id":"f49487ee-bc7c-40ad-a6c5-944142408864","name":"Erro - Pedido com QR Code (PIX ou PagBank) data de expiração maior que 180 dias","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"ex-00001\",\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"items\": [\r\n {\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"qr_codes\": [\r\n {\r\n \"amount\": {\r\n \"value\": 500\r\n }\r\n }\r\n ],\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"notification_urls\": [\r\n \"https://meusite.com/notificacoes\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/orders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40002\",\n \"description\": \"must not be more than 180 days from now\",\n \"parameter_name\": \"qr_codes[0].expiration_date\"\n }\n ]\n}"}],"_postman_id":"bfc52c5b-2829-4e30-b7a0-711cf883e5f5"},{"name":"Recebendo uma notificação de um pedido","id":"fd1b1ad9-482d-4c54-993d-57472198961a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\r\n \"reference_id\": \"ex-00001\",\r\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\r\n \"shipping\": {\r\n \"address\": {\r\n \"street\": \"Avenida Brigadeiro Faria Lima\",\r\n \"number\": \"1384\",\r\n \"complement\": \"apto 12\",\r\n \"locality\": \"Pinheiros\",\r\n \"city\": \"São Paulo\",\r\n \"region_code\": \"SP\",\r\n \"country\": \"BRA\",\r\n \"postal_code\": \"01452002\"\r\n }\r\n },\r\n \"items\": [\r\n {\r\n \"reference_id\": \"referencia do item\",\r\n \"name\": \"nome do item\",\r\n \"quantity\": 1,\r\n \"unit_amount\": 500\r\n }\r\n ],\r\n \"customer\": {\r\n \"name\": \"Jose da Silva\",\r\n \"email\": \"email@test.com\",\r\n \"tax_id\": \"12345678909\",\r\n \"phones\": [\r\n {\r\n \"country\": \"55\",\r\n \"area\": \"11\",\r\n \"number\": \"999999999\",\r\n \"type\": \"MOBILE\"\r\n }\r\n ]\r\n },\r\n \"charges\": [\r\n {\r\n \"id\": \"CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\r\n \"reference_id\": \"referencia da cobranca\",\r\n \"status\": \"PAID\",\r\n \"created_at\": \"2020-11-21T23:30:22.695-03:00\",\r\n \"paid_at\": \"2020-11-21T23:30:24.352-03:00\",\r\n \"description\": \"descricao da cobranca\",\r\n \"amount\": {\r\n \"value\": 500,\r\n \"currency\": \"BRL\",\r\n \"summary\": {\r\n \"total\": 500,\r\n \"paid\": 500,\r\n \"refunded\": 0\r\n }\r\n },\r\n \"payment_response\": {\r\n \"code\": \"20000\",\r\n \"message\": \"SUCESSO\",\r\n \"reference\": \"1606012224352\"\r\n },\r\n \"payment_method\": {\r\n \"type\": \"CREDIT_CARD\",\r\n \"installments\": 1,\r\n \"capture\": true,\r\n \"card\": {\r\n \"brand\": \"visa\",\r\n \"first_digits\": \"411111\",\r\n \"last_digits\": \"1111\",\r\n \"exp_month\": \"12\",\r\n \"exp_year\": \"2026\",\r\n \"holder\": {\r\n \"name\": \"Jose da Silva\"\r\n }\r\n }\r\n },\r\n \"links\": [\r\n {\r\n \"rel\": \"SELF\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\r\n \"media\": \"application/json\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CHARGE.CANCEL\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300/cancel\",\r\n \"media\": \"application/json\",\r\n \"type\": \"POST\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"qr_code\": {\r\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\r\n \"amount\": {\r\n \"value\": 500\r\n },\r\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\r\n \"links\": [\r\n {\r\n \"rel\": \"QRCODE.PNG\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\r\n \"media\": \"image/png\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"QRCODE.BASE64\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\r\n \"media\": \"text/plain\",\r\n \"type\": \"GET\"\r\n }\r\n ]\r\n },\r\n \"links\": [\r\n {\r\n \"rel\": \"SELF\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\r\n \"media\": \"application/json\",\r\n \"type\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"PAY\",\r\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\r\n \"media\": \"application/json\",\r\n \"type\": \"POST\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://meusite.com/notificacoes","description":"

Objeto de notificação recebido sempre que houver uma atualização no pedido, inclusive uma cobrança.

\n","urlObject":{"protocol":"https","path":["notificacoes"],"host":["meusite","com"],"query":[],"variable":[]}},"response":[{"id":"a296f8aa-1aa0-492c-a9c7-e41ce7bc3edc","name":"Pedido pago com PIX","originalRequest":{"method":"POST","header":[],"url":"https://meusite.com/notificacoes"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [\n {\n \"id\": \"CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"reference_id\": \"referencia da cobranca\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-11-21T23:30:22.695-03:00\",\n \"paid_at\": \"2020-11-21T23:30:24.352-03:00\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1606012224352\"\n },\n \"payment_method\": {\n \"type\": \"PIX\"\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n }\n ],\n \"qr_code\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"},{"id":"fcd95c70-003a-43e9-b4d4-580801b7148b","name":"Pedido pago com cartão de crédito","originalRequest":{"method":"POST","header":[],"url":"https://meusite.com/notificacoes"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [\n {\n \"id\": \"CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"reference_id\": \"referencia da cobranca\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-11-21T23:30:22.695-03:00\",\n \"paid_at\": \"2020-11-21T23:30:24.352-03:00\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1606012224352\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"visa\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"12\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Jose da Silva\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n }\n ],\n \"qr_code\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"},{"id":"32036cd6-82e5-41d6-99a8-4abc6f001c3a","name":"Pedido pago com saldo PagBank","originalRequest":{"method":"POST","header":[],"url":"https://meusite.com/notificacoes"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"reference_id\": \"ex-00001\",\n \"created_at\": \"2020-11-21T23:23:22.69-03:00\",\n \"shipping\": {\n \"address\": {\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"complement\": \"apto 12\",\n \"locality\": \"Pinheiros\",\n \"city\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"country\": \"BRA\",\n \"postal_code\": \"01452002\"\n }\n },\n \"items\": [\n {\n \"reference_id\": \"referencia do item\",\n \"name\": \"nome do item\",\n \"quantity\": 1,\n \"unit_amount\": 500\n }\n ],\n \"customer\": {\n \"name\": \"Jose da Silva\",\n \"email\": \"email@test.com\",\n \"tax_id\": \"12345678909\",\n \"phones\": [\n {\n \"country\": \"55\",\n \"area\": \"11\",\n \"number\": \"999999999\",\n \"type\": \"MOBILE\"\n }\n ]\n },\n \"charges\": [\n {\n \"id\": \"CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"reference_id\": \"referencia da cobranca\",\n \"status\": \"PAID\",\n \"created_at\": \"2020-11-21T23:30:22.695-03:00\",\n \"paid_at\": \"2020-11-21T23:30:24.352-03:00\",\n \"description\": \"descricao da cobranca\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\",\n \"reference\": \"1606012224352\"\n },\n \"payment_method\": {\n \"type\": \"BALANCE\",\n \"capture\": true,\n \"balance\": {\n \"id\": \"138510334047626086\",\n \"email\": \"comprador@email.com\"\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_F1F10115-09F4-4560-85F5-A828D9F96300/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n }\n ],\n \"qr_code\": [\n {\n \"id\": \"QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74\",\n \"amount\": {\n \"value\": 500\n },\n \"text\": \"00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879\",\n \"links\": [\n {\n \"rel\": \"QRCODE.PNG\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png\",\n \"media\": \"image/png\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"QRCODE.BASE64\",\n \"href\": \"https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/base64\",\n \"media\": \"text/plain\",\n \"type\": \"GET\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"PAY\",\n \"href\": \"https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328/pay\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ]\n}"}],"_postman_id":"fd1b1ad9-482d-4c54-993d-57472198961a"}],"id":"0268e013-9241-4902-88d1-57df28affd97","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b49f3664-6b08-499d-a744-71f6c0610f52"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ac1b0842-d37b-48d5-b4a9-1333fed83a89"}}],"_postman_id":"0268e013-9241-4902-88d1-57df28affd97","description":""},{"name":"PIX","item":[{"name":"Autenticação","item":[{"name":"Criar token associado aos escopos do PIX Json","event":[{"listen":"prerequest","script":{"id":"94a43e5c-41a7-43de-a5bf-d31462d95fa4","exec":[""],"type":"text/javascript"}}],"id":"c14c0301-87a0-42f4-9274-59a274e3d82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"grant_type\":\"client_credentials\",\r\n \"scope\": \"pix.read pix.write cob.read\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/pix/oauth2","description":"

Username: Client_ID

Password: Client_Secret

\n","urlObject":{"protocol":"https","path":["pix","oauth2"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"28ae4af3-2c77-4194-8ea5-c276f1ac8633","name":"Criar token associado aos escopos do PIX Json","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{token}}","type":"text"}],"body":{"mode":"raw","raw":"\"grant_type\": \"client_credentials\",\r\n\"scope\": \"pix.write pix.read\"","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/pix/oauth2"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{{token}}\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 31536000,\n \"refresh_token\": \"{{token}}\",\n \"scope\": \"pix.write pix.read\"\n}"},{"id":"beea2285-b458-405c-b34b-2b4c82b5a14c","name":"Criar token associado aos escopos do PIX com sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{token}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"pix.read pix.write cob.read cob.write","type":"text"}]},"url":"https://secure.sandbox.api.pagseguro.com/pix/oauth2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"7edcb33b-4ac4-4eb8-9856-dbe28a7bb7d6"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"YRukIH8goAMFgGg="},{"key":"cache-control","value":"no-store"},{"key":"pragma","value":"no-cache"},{"key":"x-amzn-Remapped-Date","value":"Mon, 28 Dec 2020 18:58:48 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"330"},{"key":"date","value":"Mon, 28 Dec 2020 18:58:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{{token}}\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 31536000,\n \"refresh_token\": \"{{token}}\",\n \"scope\": \"pix.read pix.write cob.read cob.write\"\n}"},{"id":"0a0d9f69-35bb-49c9-92aa-76fcd08a4bf8","name":"Criar token associado aos escopos do PIX com erro","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","disabled":true},{"key":"scope","value":"pix.read pix.write cob.read cob.write","type":"text"}]},"url":"https://secure.sandbox.api.pagseguro.com/pix/oauth2"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"133e5130-e28e-4f9b-9e6d-188cd47be3db"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"a5EpSFRGIAMF5WQ="},{"key":"cache-control","value":"no-store"},{"key":"pragma","value":"no-cache"},{"key":"x-amzn-Remapped-Date","value":"Wed, 17 Feb 2021 13:32:56 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"99"},{"key":"date","value":"Wed, 17 Feb 2021 13:32:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"41001\",\n \"description\": \"invalid_request\",\n \"parameter_name\": \"grant_type\"\n }\n ]\n}"}],"_postman_id":"c14c0301-87a0-42f4-9274-59a274e3d82e"}],"id":"d912dca9-2c4e-447e-b24f-1f08c626cd53","description":"

Todas as APIs públicas do PagSeguro requerem autenticação. Através da autenticação, identificamos e autorizamos o integrador a utilizar nossas APIs e seus recursos, bem como eventuais configurações adicionais.

Primeiro passo: Criar uma conta no nosso ambiente de Sandbox

https://acesso.pagseguro.uol.com.br/sandbox

Segundo passo: Gerar um Client ID OAuth 2.0, Client Secret OAuth 2.0 e Certificado Digital mTLS

Para gerar suas credenciais, abra uma solicitação no Portal PagSeguro, através do link abaixo, informando o nome da sua empresa e o e-mail registrado na Pagseguro. As chaves de acesso (client_id, client_secret e certificado digital) são confidenciais e recomendamos não compartilhá-las em ambientes públicos ou com terceiros.

Link: https://app.pipefy.com/public/form/z7Uas1lI

O SLA de resposta é de até 2 dias úteis

Terceiro passo: Gerar um token de acesso com escopos vinculados

O access token é a forma como identificamos o dono do recurso, o cliente/aplicação que solicitou acesso e as autorizações concedidas, por isso, ele deverá ser enviado em todas as requisições. \nImportante: O token tem validade de 1 ano, ou seja, pode ser usado para todas as requisições aplicáveis aos escopos associados.

Escopos

Os access tokens podem estar associados a um único escopo ou vários escopos, podendo ter diferentes combinações.

Exemplos:

Você pode gerar um token apenas para um escopo;
Você pode gerar outro token para mais de um escopo e com combinações diferentes;
Ou pode gerar outro token com todos os escopos do PIX.

Abaixo estão os escopos disponíveis para a API PIX:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Permissão
`cob.write`	Permissão para alteração de cobranças imediatas
`cob.read`	Permissão para consulta de cobranças imediatas
`pix.write`	Permissão para alteração de Pix
`pix.read`	Permissão para consulta de Pix
`webhook.write`	Permissão para alteração do webhook
`webhook.read`	Permissão para consulta do webhook
`payloadlocation.write`	Permissão para alteração de payloads
`payloadlocation.read`	Permissão para consulta de payloads

Configurando o Certificado Digital

Para solicitar um access token e utilizar a API PIX será necessário informar um certificado digital válido e ativo no header de cada requisição. Além disso, é preciso configurá-lo no POSTMAN, você consegue fazê-lo clicando no ícone da engrenagem, disponível no canto superior direito:

Settings > Settings > Certificates > Add Certificate.

CRT File = Arquivo .pem\nKEY File = Arquivo .Key

Os certificados digitais utilizados na API PIX garantem que as chamadas serão sempre assinadas e que a origem é confiável, trazendo mais segurança para toda a operação. \nO certificado sempre será fornecido pelo Pagseguro, você irá recebê-lo junto com o seu CLIENT_ID e CLIENT_SECRET via pipefy.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"773f061c-2aac-4a7a-b800-6d45219e6ab9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"50da9a8b-8bf2-4bf2-9345-08dc0412f178"}}],"_postman_id":"d912dca9-2c4e-447e-b24f-1f08c626cd53"},{"name":"Cobrança","item":[{"name":"Objeto Cobrança","id":"2c82eb0a-3379-4452-bb29-16ed249f3795","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"","description":"

Parâmetros

Campo	Tipo	Presença	Descrição
`txid`	`String [A-Z0-9-]{26,35}`	`REQUEST:Obrigatório` `RESPONSE:Sim`	O campo txid, obrigatório, representa uma cobrança e é único por CPF/CNPJ do usuário recebedor. O objetivo desse campo é ser um elemento que possibilite ao usuário recebedor a funcionalidade de conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade
`calendario`	`Objeto`	`REQUEST:Opcional` `RESPONSE:Condicional`	Organiza informações a respeito de controle de tempo da cobrança, sua data de criação e expiração
└──`expiracao`	`Int`	`REQUEST:Opcional` `RESPONSE:Condicional`	Representa o tempo de vida da cobrança, especificado em segundos a partir da data de criação
└──`criacao`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Representa o momento em que a cobrança foi criada. Exemplo: `2020-09-09T20:15:00.358Z`
`devedor`	`Objeto`	`REQUEST:Opcional` `RESPONSE:Condicional`	Identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento
└──`cpf`	`String(11 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CPF da pessoa física devedora
└──`cnpj`	`String(14 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CNPJ da pessoa jurídica devedora
└──`nome`	`String(1-200 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	Nome da pessoa física ou jurídica devedora
`valor`	`Objeto`	`REQUEST:Obrigatório` `RESPONSE:Sim`	Os campos que indicam valores monetários obedecem a especificação onde o separador decimal é o caracter ponto (.), não é aplicável utilizar separador de milhar. Exemplos: “1.00”, “123.99”, “123456789.23”
└──`original`	`String [\\d{1,10}\\.\\d{2}]`	`REQUEST:Obrigatório` `RESPONSE:Sim`	Representa o valor original total da cobrança
`chave`	`String (1-77 caracteres)`	`REQUEST:Obrigatório` `RESPONSE:Sim`	O campo chave, determina a chave Pix registrada no DICT que será utilizada para endereçar a cobrança. Para fins de teste, em ambiente de Sandbox, qualquer chave é válida. A chave (CPF, CPNPJ, eMail, telefone, chave aleatória) pode ser cadastrada na área logada da sua conta PagSeguro, app ou web.
`solicitacaopagador`	`String (1-140 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor
`infoadicionais`	`Array de objetos`	`REQUEST:Opcional` `RESPONSE:Condicional`	Organiza informações adicionais que, se utilizadas, devem ser apresentadas ao usuário pagador
└──`nome`	`String (1-50 caracteres)	`REQUEST:Obrigatório` `RESPONSE:Sim`	Nome do campo
└──`valor`	`String (1-200 caracteres)`	`REQUEST:Obrigatório` `RESPONSE:Sim`	Dados do campo
`revisao`	`Int`	`REQUEST:Não` `RESPONSE:Sim`	Revisão da cobrança, sempre começa em zero e varia em acréscimos de 1 a cada alteração dos dados da cobrança
`location`	`String (77 caracteres)`	`REQUEST:Não` `RESPONSE:Sim`	Representa a localização do payload de cobrança
`status`	`String`	`REQUEST:Não` `RESPONSE:Sim`	Representa o status de uma cobrança: `\"ATIVA: Cobrança criada.\"` `\"CONCLUIDA: Indica que a cobrança foi paga e não pode aceitar outro pagamento. Importante destacar que o estado CONCLUÍDA refere-se à cobrança gerada e não à liquidação da obrigação em si\"` `\"REMOVIDA_PELO_USUARIO_RECEBEDOR: Cobrança removida pelo requisitante, usuário recebedor.\"` `\"REMOVIDA_PELO_PSP: Cobrança removida pela Pagseguro.\"`
`pix`	`Array de objetos`	`REQUEST:Não` `RESPONSE:Condicional`	Organiza informações dos recebimentos vinculados à uma cobrança
└──`endToEndId`	`String [A-Z0-9-]{1,35}`	`REQUEST:Não` `RESPONSE:Sim`	ID fim a fim que transita nas mensagens PACS002, PACS004 e PACS008
└──`txid`	`String [A-Z0-9-]{26,35}`	`REQUEST:Não` `RESPONSE:Sim`	O parâmetro, obrigatório, representa o identificador único da cobrança
└──`valor`	`String \\d{1,10}\\.\\d{2}`	`REQUEST:Não` `RESPONSE:Sim`	Representa o valor do PIX
└──`horario`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário em que o Pix foi processado no PSP
└──`pagador`	`Objeto (Pessoa Física ou Pessoa Jurídica)	`REQUEST:Não` `RESPONSE:Condicional`	Representa quem efetivamente quem realizou o pagamento, podendo ser diferente do vendedor. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento
└──`cpf`	`String(11 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CPF da pessoa física devedora
└──`cnpj`	`String(14 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CNPJ da pessoa jurídica devedora
└──`nome`	`String(1-200 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	Nome da pessoa física ou jurídica devedora
└──`infopagador`	`String (1-140) caracteres)`	`REQUEST:Não` `RESPONSE:Condicional`	Informações livres do pagador
└──`devolucoes`	`Array de objetos`	`REQUEST:Não` `RESPONSE:Condicional`	Organiza informações de devoluções vinculadas à cobrança
└──└──`id`	`String [A-Z0-9-]{1,35}`	`REQUEST:Não` `RESPONSE:Sim`	ID gerado pelo cliente para representar unicamente uma devolução
└──└──`rtrid`	`String (32 caracteres)`	`REQUEST:Não` `RESPONSE:Sim`	ReturnIdentification que transita na PACS004
└──└──`valor`	`String \\d{1,10}\\.\\d{2}`	`REQUEST:Não` `RESPONSE:Sim`	Valor a Devolver
└──└──`horario`	`Objeto`	`REQUEST:Não` `RESPONSE:Sim`	Horários em que uma devolução foi solicitada e se aplicável, liquidada
└──└──`solicitacao`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário no qual a devolução foi solicitada no PSP
└──└──`liquidacao`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário no qual a devolução foi liquidada no PSP
└──└──`status`	`String`	`REQUEST:Não` `RESPONSE:Sim`	Status da devolução: `EM_PROCESSAMENTO`, `DEVOLVIDO` e `NAO_REALIZADO`
└──└──`motivo`	`String (1-140 caracteres)`	`REQUEST:Não` `RESPONSE:Não`	Descrição do status da devolução. Exemplos: `REFUND_TRANS_INVALID_REFUND_VALUE_LESS_THAN_ALLOWED` `REFUND_TRANS_INVALID_REFUND_VALUE_GREATER_THAN_ALLOWED` `REFUND_TRANS_INVALID_INSUFFICIENT_BALANCE` `REFUND_TRANS_UNKNOWN_TRANSACTION_EXCEPTION` `REFUND_TRANS_PM_UNSUPPORTED` `PARTIAL_REFUND_EXCEPTION` `REFUND_TRANS_PIN_REPLACEMENT_EXCEPTION`

Erros Cobrança

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código	Nome	Descrição
40002	Invalid method argument	Apresentado quando um ou mais campos da requisição estiverem com formato inválido. O campo sempre acompanha uma descrição, por exemplo: Caso você esqueça de preencher um CPF/CNPF mas tiver preenchido o nome do devedor `If you input debtor name, you must input a valid CPF or CNPJ`

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f80e263-b158-486a-ad8a-16d2f43521fe","id":"9f80e263-b158-486a-ad8a-16d2f43521fe","name":"Cobrança","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"2c82eb0a-3379-4452-bb29-16ed249f3795"},{"name":"Criar Cobrança","id":"049e1b5f-9686-4e92-81b3-fd850fe1e493","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"calendario\": {\r\n \"expiracao\": \"3600\"\r\n },\r\n \"devedor\": {\r\n \"cpf\": \"41444444444\",\r\n \"nome\": \"Exemplo\"\r\n },\r\n \"valor\": {\r\n \"original\": \"1.20\"\r\n },\r\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\r\n \"solicitacaoPagador\": \"Serviço realizado.\",\r\n \"infoAdicionais\": [\r\n {\r\n \"nome\": \"Campo 1\",\r\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\r\n },\r\n {\r\n \"nome\": \"Campo 2\",\r\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob/{{txid}}","description":"

Endpoint para criação de uma cobrança imediata.

\n","urlObject":{"protocol":"https","path":["instant-payments","cob","{{txid}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"98e7359a-ed30-452c-a669-c6cc75e91d16","name":"Criar Cobrança com todos os campos obrigatórios e opcionais","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"calendario\": {\r\n \"expiracao\": \"3600\"\r\n },\r\n \"devedor\": {\r\n \"cpf\": \"41444444444\",\r\n \"nome\": \"Exemplo\"\r\n },\r\n \"valor\": {\r\n \"original\": \"1.20\"\r\n },\r\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\r\n \"solicitacaoPagador\": \"Serviço realizado.\",\r\n \"infoAdicionais\": [\r\n {\r\n \"nome\": \"Campo 1\",\r\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\r\n },\r\n {\r\n \"nome\": \"Campo 2\",\r\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob/123BAJDH1JASHjvkae123kejauuj745"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"d2c34e76-f3c0-4d8c-be8e-664b0ad4396a"},{"key":"x-amzn-Remapped-Content-Length","value":"567"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"a5GmaGypIAMF1sQ="},{"key":"x-amzn-Remapped-Date","value":"Wed, 17 Feb 2021 13:46:17 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"567"},{"key":"date","value":"Wed, 17 Feb 2021 13:46:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ATIVA\",\n \"calendario\": {\n \"expiracao\": 3600,\n \"criacao\": \"2021-02-17T13:46:17Z\"\n },\n \"location\": \"sandbox.api.pagseguro.com/pix/v2/6BA71305-E6C4-416A-A202-D17FE2E87001\",\n \"txid\": \"123BAJDH1JASHjvkae123kejauuj745\",\n \"revisao\": 0,\n \"devedor\": {\n \"cpf\": \"41495193829\",\n \"nome\": \"Leticia Oliveira Porto Latsch\"\n },\n \"valor\": {\n \"original\": \"1.20\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n}"},{"id":"a639344f-edbe-4cf3-91a6-f262a7543392","name":"Criar Cobrança com sucesso - Campos obrigatórios","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": {\r\n \"original\": \"1.10\"\r\n },\r\n \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.api.pagseguro.com/instant-payments/cob/123BAJDH1JASHjvkae123kejascj366"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"2f364915-7f50-467f-bf89-3d3f2bc236a5"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"XZVenGPdmjQFhZw="},{"key":"x-amzn-Remapped-Date","value":"Fri, 11 Dec 2020 16:20:46 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"309"},{"key":"date","value":"Fri, 11 Dec 2020 16:20:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ATIVA\",\n \"calendario\": {\n \"criacao\": \"2020-12-11T16:20:45Z\",\n \"expiracao\": \"86400\"\n },\n \"location\": \"api.pagseguro.com/pix/v2/FF112FC2-81C5-4F4B-96E7-2BDFEB959566\",\n \"txid\": \"123BAJDH1JASHjvkae123kejascj366\",\n \"revisao\": 0,\n \"valor\": {\n \"original\": \"1.10\"\n },\n \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\",\n \"infoAdicionais\": []\n}"}],"_postman_id":"049e1b5f-9686-4e92-81b3-fd850fe1e493"},{"name":"Simular Pagamento de Cobrança em Sandbox","id":"3afac2e6-3892-47b1-9a39-c373cbd53097","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"PAID\",\r\n \"tx_id\": \"\"\r\n}"},"url":"https://sandbox.api.pagseguro.com/pix/pay/{txid}","description":"

Endpoint criado para que em Sandbox, o usuário recebedor possa simular o pagamento de uma cobrança imediata. Assim que simulado o pagamento, a cobrança antes ATIVA terá o seu status atualizado para CONCLUÍDA.\nApós conclusão, a cobrança não aceita um novo pagamento.\nO TOKEN para simulação de pagamento é DIFERENTE do token client_credencials, ele pode ser recuperado no ambiente de SANDBOX da PagSeguro:

https://sandbox.pagseguro.uol.com.br

Após login e senha > Perfis de Integração > Vendedor > Credenciais \"Seu Token é\".

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f80e263-b158-486a-ad8a-16d2f43521fe","id":"9f80e263-b158-486a-ad8a-16d2f43521fe","name":"Cobrança","type":"folder"}},"urlObject":{"protocol":"https","path":["pix","pay","{txid}"],"host":["sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"7cbcad18-3ffe-4aed-8831-eea79e2d37c1","name":"Simular Pagamento de Cobrança em Sandbox","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"PAID\",\r\n \"tx_id\": \"aeTRnu458712596325874lpoiYbgtr\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.pagseguro.com/pix/pay/aeTRnu458712596325874lpoiYbgtr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 26 Feb 2021 21:33:04 GMT"},{"key":"x-amzn-RequestId","value":"83b31a8c-7fb2-4d67-b255-0ab79119376a"},{"key":"x-amzn-Remapped-Content-Length","value":"0"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"bX1aIFtzIAMFfgg="},{"key":"x-amzn-Remapped-Date","value":"Fri, 26 Feb 2021 21:33:04 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7d6e6b6a10e59ed96180edf0ca14ce71.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C2"},{"key":"X-Amz-Cf-Id","value":"TyE5CpkZVbjfzoFTFVJo6b0zpJk4Ucl_pNwnj3niTL-Y1YtU2aLPtA=="}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3afac2e6-3892-47b1-9a39-c373cbd53097"},{"name":"Revisar cobrança","id":"70c49e5a-1d72-48fa-8409-eaa11a2a150e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.api.pagseguro.com/instant-payments/cob/{{txid}}","description":"

Endpoint para atualizar ou remover uma cobrança previamente criada. Apenas cobranças ATIVAS podem ser atualizadas. Toda cobrança tem um controle de revisão que começa em zero e varia em acréscimos de 1. Caso a mesma seja editada e você queira consultá-la posteriormente, deve sempre considerar a sua revisão.

\n","urlObject":{"protocol":"https","path":["instant-payments","cob","{{txid}}"],"host":["secure","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"7a88c82f-f7c9-4500-a8cc-d7a5f5c92179","name":"Revisar cobrança - Valor e Inclusão de dados do Devedor","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n\"devedor\": {\r\n\"cpf\": \"12345678909\",\r\n\"nome\": \"Francisco da Silva\"\r\n},\r\n\"valor\": {\r\n\"original\": \"123.45\"\r\n},\r\n\"solicitacaoPagador\": \"Cobrança dos serviços prestados.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.api.pagseguro.com/instant-payments/cob/{{txid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"calendario\": {\n \"expiracao\": 86400,\n \"criacao\": \"2021-04-19T17:16:20Z\"\n },\n \"txid\": \"123BAJDH1JASHjvkae123kejauujpoi\",\n \"revisao\": 1,\n \"status\": \"ATIVA\",\n \"devedor\": {\n \"cpf\": \"12345678909\",\n \"nome\": \"Francisco da Silva\"\n },\n \"valor\": {\n \"original\": \"123.45\"\n },\n \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\",\n \"solicitacaoPagador\": \"Cobrança dos serviços prestados.\",\n \"infoAdicionais\": []\n}"},{"id":"232e6ae7-b313-41a2-acab-e8307d6f9fe4","name":"Revisar cobrança - Atualização de Status","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.api.pagseguro.com/instant-payments/cob/{{txid}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"calendario\": {\n \"expiracao\": 86400,\n \"criacao\": \"2021-04-19T17:16:20Z\"\n },\n \"txid\": \"123BAJDH1JASHjvkae123kejauujpoi\",\n \"revisao\": 2,\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"devedor\": {\n \"cpf\": \"12345678909\",\n \"nome\": \"Francisco da Silva\"\n },\n \"valor\": {\n \"original\": \"123.45\"\n },\n \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\",\n \"solicitacaoPagador\": \"Cobrança dos serviços prestados.\",\n \"infoAdicionais\": []\n}"}],"_postman_id":"70c49e5a-1d72-48fa-8409-eaa11a2a150e"},{"name":"Consultar cobrança","id":"ccad356f-bdba-4105-b079-5cda9cbcecc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob/{{txid}}?revisao=0","description":"

Endpoint para consultar uma cobrança através de um determinado txid. As cobranças podem ter revisões, e no momento da busca é importante se atentar a isso. \nPor exemplo:

Uma cobrança imediata criada, sem edições posteriores, fica com a revisão \"0\":

https://secure.sandbox.api.pagseguro.com/instant-payments/cob/{{txid}}?revisao=0

Caso seja editada, assumiria a revisão \"1\":

https://secure.sandbox.api.pagseguro.com/instant-payments/cob/{{txid}}?revisao=1

\n","urlObject":{"protocol":"https","path":["instant-payments","cob","{{txid}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[{"key":"revisao","value":"0"}],"variable":[]}},"response":[{"id":"79620dfe-1994-4508-a848-522a8ee3c457","name":"1. Consultar cobrança - Com sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"","type":"text"},{"key":"x-user-customer-id","value":"","type":"text"}],"url":{"raw":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob/123BAJDH1JASHjvkae123kejascj1231?revisao=0","protocol":"https","host":["secure","sandbox","api","pagseguro","com"],"path":["instant-payments","cob","123BAJDH1JASHjvkae123kejascj1231"],"query":[{"key":"revisao","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"52ae8b19-ce8d-4dc2-a030-bfb48372d936"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"Wdr41E3zoAMFYCA="},{"key":"x-amzn-Remapped-Date","value":"Mon, 23 Nov 2020 13:59:20 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"573"},{"key":"date","value":"Mon, 23 Nov 2020 13:59:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/CE32BF0F-F52C-425F-B059-CDFD4F350D9C\",\n \"calendario\": {\n \"criacao\": \"2020-11-20T16:45:46Z\",\n \"expiracao\": 3600\n },\n \"txid\": \"123BAJDH1JASHjvkae123kejascj1231\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"pix\": [],\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n}"},{"id":"cc15ec6e-4e5e-4b64-ae8e-1711a16844f8","name":"2. Consultar cobrança com erro - Formatação do TXId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob/123BAJDH1JASHjv-kae123kejascj1231?revisao=0","protocol":"https","host":["secure","sandbox","api","pagseguro","com"],"path":["instant-payments","cob","123BAJDH1JASHjv-kae123kejascj1231"],"query":[{"key":"revisao","value":"0"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"4512cac7-6588-4666-b383-a69c8051603e"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"XMT8pFCvoAMF45A="},{"key":"x-amzn-Remapped-Date","value":"Mon, 07 Dec 2020 17:30:32 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"74"},{"key":"date","value":"Mon, 07 Dec 2020 17:30:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40002\",\n \"description\": \"Invalid TxId inputed\"\n }\n ]\n}"}],"_postman_id":"ccad356f-bdba-4105-b079-5cda9cbcecc4"},{"name":"Consultar lista de cobrança","id":"0c0f6f4d-41f4-449f-abfc-f0c3784eb5e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob?fim=2020-12-31T15:25:59.411Z&inicio=2020-09-11T15:25:59.411Z","description":"

Endpoint para consultar uma lista de cobranças através dos parâmetros data inicio, data fim, txid, status, cpf e cnpj.

\n","urlObject":{"protocol":"https","path":["instant-payments","cob"],"host":["secure","sandbox","api","pagseguro","com"],"query":[{"key":"fim","value":"2020-12-31T15:25:59.411Z"},{"key":"inicio","value":"2020-09-11T15:25:59.411Z"}],"variable":[]}},"response":[{"id":"685030c1-a3ef-4ad6-a748-11f61e3da7b5","name":"1. Consultar lista de cobrança - Com sucesso","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob?fim=2020-12-31T15:25:59.411Z&inicio=2020-09-11T15:25:59.411Z","protocol":"https","host":["secure","sandbox","api","pagseguro","com"],"path":["instant-payments","cob"],"query":[{"key":"fim","value":"2020-12-31T15:25:59.411Z"},{"key":"inicio","value":"2020-09-11T15:25:59.411Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"5cfaec64-47b9-4979-aa81-3d6c24f24ef2"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"WdhLvEZ1oAMFzRw="},{"key":"x-amzn-Remapped-Date","value":"Mon, 23 Nov 2020 12:46:16 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"3463"},{"key":"date","value":"Mon, 23 Nov 2020 12:46:16 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"parametros\": {\n \"inicio\": \"2020-09-11T15:25:59Z\",\n \"fim\": \"2020-12-31T15:25:59Z\",\n \"paginacao\": {\n \"paginaAtual\": 0,\n \"itensPorPagina\": 100,\n \"quantidadeDePaginas\": 1,\n \"quantidadeTotalDeItens\": 7\n }\n },\n \"cobs\": [\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/73AE21D5-0CCA-477F-A483-62E367789EC6\",\n \"calendario\": {\n \"criacao\": \"2020-11-21T02:37:35Z\",\n \"expiracao\": 86400\n },\n \"txid\": \"123456765432345654345678903\",\n \"revisao\": 0,\n \"devedor\": {},\n \"valor\": {\n \"original\": \"2.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"pix\": [],\n \"infoAdicionais\": []\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/28CDFE54-931E-4D0D-90B9-B928F658FA0E\",\n \"calendario\": {\n \"criacao\": \"2020-11-13T16:36:38Z\",\n \"expiracao\": 3600\n },\n \"txid\": \"12345678910\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"pix\": [],\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/90DA24F9-BD28-4BBD-A1EE-249674176B28\",\n \"calendario\": {\n \"criacao\": \"2020-11-13T17:20:53Z\",\n \"expiracao\": 3600\n },\n \"txid\": \"12345678911\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"pix\": [],\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/0DB83D71-36E7-41A0-8C6B-4D58E23C1FBB\",\n \"calendario\": {\n \"criacao\": \"2020-11-13T17:31:40Z\",\n \"expiracao\": 86400\n },\n \"txid\": \"12345678912\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"pix\": [],\n \"infoAdicionais\": []\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/CE32BF0F-F52C-425F-B059-CDFD4F350D9C\",\n \"calendario\": {\n \"criacao\": \"2020-11-20T16:45:46Z\",\n \"expiracao\": 3600\n },\n \"txid\": \"123BAJDH1JASHjvkae123kejascj1231\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"pix\": [],\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/EF773BFE-786F-411B-B4E7-B3502678509D\",\n \"calendario\": {\n \"criacao\": \"2020-11-23T12:43:36Z\",\n \"expiracao\": 3600\n },\n \"txid\": \"456BAJDH1JASHjvkae123kejascj1231\",\n \"revisao\": 0,\n \"devedor\": {\n \"cnpj\": \"12345678000195\",\n \"nome\": \"Empresa de Serviços SA\"\n },\n \"valor\": {\n \"original\": \"37.00\"\n },\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"solicitacaoPagador\": \"Serviço realizado.\",\n \"pix\": [],\n \"infoAdicionais\": [\n {\n \"nome\": \"Campo 1\",\n \"valor\": \"Informação Adicional1 do PSP-Recebedor\"\n },\n {\n \"nome\": \"Campo 2\",\n \"valor\": \"Informação Adicional2 do PSP-Recebedor\"\n }\n ]\n },\n {\n \"status\": \"ATIVA\",\n \"location\": \"sandbox.api.pagseguro.com/pix/A10B1816-4E73-4E56-A29A-6AF7D3D06C0D\",\n \"calendario\": {\n \"criacao\": \"2020-11-13T16:48:37Z\",\n \"expiracao\": 86400\n },\n \"txid\": \"65498798321323\",\n \"revisao\": 0,\n \"devedor\": {},\n \"valor\": {\n \"original\": \"1.45\"\n },\n \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\",\n \"pix\": [],\n \"infoAdicionais\": []\n }\n ]\n}"},{"id":"4d718762-d175-4fbc-adfc-ec820e163e3f","name":"2. Consultar lista de cobrança - Com erro ","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.sandbox.api.pagseguro.com/instant-payments/cob?fim=2020-12-31T15:25:59.411Z&inicio=A","protocol":"https","host":["secure","sandbox","api","pagseguro","com"],"path":["instant-payments","cob"],"query":[{"key":"fim","value":"2020-12-31T15:25:59.411Z"},{"key":"inicio","value":"A"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"a2f5725f-24a0-4a5e-a181-05661f965b92"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"XMUFxGZWoAMF-oQ="},{"key":"x-amzn-Remapped-Date","value":"Mon, 07 Dec 2020 17:31:29 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"74"},{"key":"date","value":"Mon, 07 Dec 2020 17:31:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"40002\",\n \"description\": \"Invalid Date inputed\"\n }\n ]\n}"}],"_postman_id":"0c0f6f4d-41f4-449f-abfc-f0c3784eb5e0"}],"id":"9f80e263-b158-486a-ad8a-16d2f43521fe","description":"

A cobrança é caracterizada por um conjunto de informações essenciais que são utilizadas para que um usuário pagador execute um pagamento por meio do PIX à um usuário recebedor. Esse endpoint permite a criação, atualização e consulta de uma ou mais cobranças PIX.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Método	Função	Tipo
PUT	Criação de cobrança	Permite criar uma cobrança PIX
PATCH	Revisão de cobrança	Permite revisar uma cobrança PIX criada previamente
GET	Consultar Cobrança	Permite consultar uma ou mais cobranças PIX criadas previamente

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"21a87c01-e669-4923-8645-38d81f6532ae"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0579d56d-d763-4500-ac5f-c4a6ce060f18"}}],"_postman_id":"9f80e263-b158-486a-ad8a-16d2f43521fe"},{"name":"Payload JSON que representa uma Cobrança","item":[{"name":"Objeto ","id":"6cba0494-1bfc-4772-8d51-cc085e85b65e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"","description":"

Endpoint (location) que serve um payload que representa uma cobrança imediata.\nNo momento que o usuário pagador efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em:\nhttps://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados

\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6cba0494-1bfc-4772-8d51-cc085e85b65e"},{"name":"Recuperar o payload JSON que representa a cobrança imediata.","id":"e4680a21-7817-47d5-bb67-bcc9ffb9e79e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{Location}","description":"

URL gerada na criação da cobrança e acessada no momento que o usuário pagador efetua a leitura de um QR Code dinâmico gerado pelo recebedor.

Exemplo de uma location, disponível no response de uma cobrança imediata gerada com sucesso no endpoint /cob:

{ \"status\": \"ATIVA\", \"calendario\": { \"criacao\": \"2020-12-11T16:20:45Z\", \"expiracao\": \"86400\" }, \"location\": \"api.pagseguro.com/pix/v2/KK112FC2-81C5-4F4B-96E7-2BDFLE959777\", \"txid\": \"123BAJDH1JASHjvkae123kejascj366\", \"revisao\": 0, \"valor\": { \"original\": \"1.10\" }, \"chave\": \"b5fe91c3-6dd1-4bd8-9466-ca3a29a77a26\", \"infoAdicionais\": [] }

\n","urlObject":{"protocol":"https","host":["{Location}"],"query":[],"variable":[]}},"response":[{"id":"16594bca-2f1d-4c5a-8fd4-85bbe417bf5f","name":"Recuperar o payload JSON que representa a cobrança imediata.","originalRequest":{"method":"GET","header":[],"url":"http://{Location}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"925"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 05 Jan 2021 21:13:55 GMT"},{"key":"x-amzn-RequestId","value":"b3a73e42-22bf-417c-9bab-370e4266c523"},{"key":"x-amzn-Remapped-Content-Length","value":"925"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"YsZ3AFVPoAMFlQQ="},{"key":"x-amzn-Remapped-Date","value":"Tue, 05 Jan 2021 21:13:55 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8b2a98682e221cca97ad71d86a718ee5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C1"},{"key":"X-Amz-Cf-Id","value":"oWL504klWJqKysRGZCIMZ69_vBObv46MUDUsYp1UbyI3eQ39QcBHWA=="}],"cookie":[],"responseTime":null,"body":"eyJ4NXQjUzI1NiI6IkZ5WTJ5aXZCR2Q1SDJYX1l5YzZtTmlYLXVwQ1BxTThVMlctWEFxV3ZPelkiLCJqa3UiOiJodHRwczpcL1wvc2FuZGJveC5hcGkucGFnc2VndXJvLmNvbVwvLndlbGwta25vd25cL3BpeC1qd2tzIiwieDV0IjoiYXlGbVAzZ2d0aWJ0Z2tOR1RKaWo1SWxfaUU0Iiwia2lkIjoiMzgwMTgwNjMyMTk1NjQ2MDY2NDgyNTEzMzM0NTYxNzM2OTcwNiIsImFsZyI6IlBTNTEyIn0.eyJyZXZpc2FvIjowLCJjYWxlbmRhcmlvIjp7ImNyaWFjYW8iOiIyMDIxLTAxLTA1VDIwOjU3OjQzWiIsImFwcmVzZW50YWNhbyI6IjIwMjEtMDEtMDVUMjE6MTM6NTVaIn0sInZhbG9yIjp7Im9yaWdpbmFsIjoiMjAuMTAifSwiY2hhdmUiOiJkaW9uZWFnQG1vY2suY29tIiwidHhpZCI6ImJhYWEwcXFhMGE1NTEyZGFzYTAwMXNkYWFneXMwMDEyIiwic3RhdHVzIjoiQVRJVkEifQ.BrvMuZdhSmRvKwAjsZLhaoN7lm9hI1d9eb2rZK56NvKiY8amYH0n4qIEOYwJigaAruEc6qbozWuLT4nXF1SEEdm9timoLoAfk3cuk8USaqry3D67IYv1vcVs1VNW_j9hLf4lM-zDOsopRlmY6-FDL24w7sY4IfBJQf-PNxOFnGYDPcGEXM4TZVveSq84xHQUFsonokBacJ-ii_MxsdZAkroG3ipt6TwzVCGagAr1SVadVQ3dKljxPhGi1_fWLUFfmeUtcy04xWNpAxZtE9FfMJs0mfaPuHz8ZQymY0oRNZvFjB4Q12OPh0tm5O3Hz8dzNn7QCJ86SbTqSfcq-WtDSB"}],"_postman_id":"e4680a21-7817-47d5-bb67-bcc9ffb9e79e"}],"id":"58bdcc08-7237-470b-8477-cc1f92659cde","_postman_id":"58bdcc08-7237-470b-8477-cc1f92659cde","description":""},{"name":"Gerenciamento de recebimentos","item":[{"name":"Objeto Recebimento","id":"ff19c430-7d93-4ee6-85f4-7ddc9d6ac011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"","description":"

Parâmetros e objetos que compõe uma consulta de Recebimento

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`e2eid`	`String [A-Z0-9-]{1,35}`	`REQUEST:Não` `RESPONSE:Sim`	O parâmetro, obrigatório, representa o ID fim a fim da transação que transita na PACS002, PACS004 e PACS008. O e2eid fica disponível após uma cobrança estar concluída e você pode encontrá-lo no response da consulta da cobrança get/cob
`txid`	`String [A-Z0-9-]{26,35}`	`REQUEST:Não` `RESPONSE:Sim`	O parâmetro, obrigatório, representa o identificador único da cobrança
`valor`	`String \\d{1,10}\\.\\d{2}`	`REQUEST:Não` `RESPONSE: Sim`	Representa o valor do PIX
`horario`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário em que o Pix foi processado no PSP
`pagador`	`Objeto`	`REQUEST:Não` `RESPONSE:Não`	Representa quem efetivamente quem realizou o pagamento, podendo ser diferente do vendedor. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento
└──`cpf`	`String(11 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CPF da pessoa física devedora
└──`cnpj`	`String(14 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	CNPJ da pessoa jurídica devedora
└──`nome`	`String(1-200 caracteres)`	`REQUEST:Opcional` `RESPONSE:Condicional`	Nome da pessoa física ou jurídica devedora
`infopagador`	`String (1-140) caracteres)`	`REQUEST:Não` `RESPONSE:Condicional`	Informações livres do pagador
`inicio`	`String [date-time]`	`REQUEST:Sim` `RESPONSE:Sim`	Filtra os recebimentos PIX cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339
`fim`	`String [date-time]`	`REQUEST:Sim` `RESPONSE:Sim`	Filtra os recebimentos PIX cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339
`paginacao.paginaAtual`	`Int (Página atual) >= 0/ Valor Default = 0`	`REQUEST:Opcional` `RESPONSE:Condicional`	Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0
`paginacao.itensPorPagina`	`Int (Itens por Página) [ 1 .. 1000 ]/ Valor Default = 100`	`REQUEST:Opcional` `RESPONSE:Condicional`	Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros

","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ff19c430-7d93-4ee6-85f4-7ddc9d6ac011"},{"name":"Objeto Devolução","id":"3deb36ee-8eae-4747-be59-9838cdd783de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"","description":"

Parâmetros

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Presença	Descrição
`e2eid`	`String [A-Z0-9-]{1,35}`	`REQUEST:Obrigatório` `RESPONSE:Sim`	O parâmetro, obrigatório, representa o ID fim a fim da transação que transita na PACS002, PACS004 e PACS008. O e2eid fica disponível após uma cobrança estar concluída e você pode encontrá-lo no response da consulta da cobrança get/cob
`id`	`String [A-Z0-9-]{1,35}`	`REQUEST:Não` `RESPONSE:Sim`	ID que representa uma devolução e é único por CPF/CNPJ do usuário recebedor. O objetivo desse campo é ser um elemento que possibilite ao usuário recebedor a funcionalidade de conciliação de pagamentos. O ID é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade
`rtrId`	`String (32 caracteres)`	`REQUEST:Não` `RESPONSE:Sim`	ReturnIdentification que transita na PACS004
`valor`	`String \\d{1,10}\\.\\d{2}`	`REQUEST:Não` `RESPONSE:Sim`	Valor a Devolver
`horario`	`Objeto`	`REQUEST:Não` `RESPONSE:Sim`	Horários em que uma devolução foi solicitada e se aplicável, liquidada
`solicitacao`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário no qual a devolução foi solicitada no PSP
`liquidacao`	`String [date-time]`	`REQUEST:Não` `RESPONSE:Sim`	Horário no qual a devolução foi liquidada no PSP
`status`	`String`	`REQUEST:Não` `RESPONSE:Sim`	Status da devolução: `EM_PROCESSAMENTO`, `DEVOLVIDO` e `NAO_REALIZADO`
`motivo`	`String (1-140 caracteres)`	`REQUEST:Não` `RESPONSE:Não`	Descrição do status da devolução. Exemplos: `REFUND_TRANS_INVALID_REFUND_VALUE_LESS_THAN_ALLOWED` `REFUND_TRANS_INVALID_REFUND_VALUE_GREATER_THAN_ALLOWED` `REFUND_TRANS_INVALID_INSUFFICIENT_BALANCE` `REFUND_TRANS_UNKNOWN_TRANSACTION_EXCEPTION` `REFUND_TRANS_PM_UNSUPPORTED` `PARTIAL_REFUND_EXCEPTION` `REFUND_TRANS_PIN_REPLACEMENT_EXCEPTION`

","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3deb36ee-8eae-4747-be59-9838cdd783de"},{"name":"Solicitar devolução","id":"b1b25c1c-f4f0-41d7-9413-7ed67ba64582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"7.89\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/{e2eid}/devolucao/{id}","description":"

Endpoint para solicitar devolução total de um PIX. Caso o valor informado na requisição de devolução seja diferente do valor original da cobrança é possível simular o cenário de devolução NÃO REALIZADA em Sandbox.\nO ID da devolução é único e criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.

\n","urlObject":{"protocol":"https","path":["instant-payments","pix","{e2eid}","devolucao","{id}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"b0dfdd0a-6139-4fab-a54f-83c0b8d006a3","name":"Com sucesso","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"7.89\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/E12345678202009091221abcdef00001/devolucao/123456"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"d5a6263b-8166-48af-ad09-1469913b0f4e"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"WGYOHE3SIAMFb9g="},{"key":"x-amzn-Remapped-Date","value":"Mon, 16 Nov 2020 12:16:15 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"109"},{"key":"date","value":"Mon, 16 Nov 2020 12:16:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\":\"123\",\n \"rtrId\":\"8c028b046fa242368e9d5aed52e8e8ad\",\n \"valor\":\"7.89\",\n \"horario\":\n {\n \"solicitacao\":\"2020-11-16T12:43:57Z\"\n },\n \"status\":\"EM_PROCESSAMENTO\"\n}"},{"id":"1c367691-7a87-4ef4-9acc-6bb333d70e13","name":"Erro na formatação de campo obrigatório","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\"valor\": \"7.89\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/E12345678202009091221abcdef00001/devolucao/123456"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"d5a6263b-8166-48af-ad09-1469913b0f4e"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"WGYOHE3SIAMFb9g="},{"key":"x-amzn-Remapped-Date","value":"Mon, 16 Nov 2020 12:16:15 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"109"},{"key":"date","value":"Mon, 16 Nov 2020 12:16:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error_messages\": [\n {\n \"code\": \"APIX-10003\",\n \"message\": \"The field [e2eid] must fit the pattern [A-Z0-9-]{1,35}\"\n }\n ]\n}"},{"id":"f62f44f9-1d83-4894-a46d-2319fa13e0f0","name":"Simular cenário de devolução NÃO_REALIZADA","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"1.11\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/a08a34dfbfdd46f68bba1783179ee75d/devolucao/1458"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"7f62fc3f-7937-4f04-bad2-ac7522d4e0cf"},{"key":"x-amzn-Remapped-Content-Length","value":"152"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"a8TwrGhhoAMFTaA="},{"key":"x-amzn-Remapped-Date","value":"Thu, 18 Feb 2021 13:06:51 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"152"},{"key":"date","value":"Thu, 18 Feb 2021 13:06:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1458\",\n \"rtrId\": \"D08561701202102181306YASA9KVTEQT\",\n \"valor\": \"1.11\",\n \"horario\": {\n \"solicitacao\": \"2021-02-18T13:06:50.850652Z\"\n },\n \"status\": \"NAO_REALIZADO\"\n}"}],"_postman_id":"b1b25c1c-f4f0-41d7-9413-7ed67ba64582"},{"name":"Consultar devolução","id":"0fa9034f-4519-42ac-a57c-399799338c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/{{endtoendId}}/devolucao/{{id}}","description":"

Endpoint para consultar uma devolução através de um End To End ID do Pix e ID da devolução, criado pelo usuário recebedor.

\n","urlObject":{"protocol":"https","path":["instant-payments","pix","{{endtoendId}}","devolucao","{{id}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"8dca7bbb-3e10-4d2a-aaaf-fc1dfd3abf34","name":"Consultar devolução","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/{{e2eid}}/devolucao/{{id}}"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"123456\",\n \"rtrId\": \"D12345678202009091000abcde123456\",\n \"valor\": \"7.89\",\n \"horario\": {\n \"solicitacao\": \"2020-09-11T15:25:59.411Z\"\n },\n \"status\": \"EM_PROCESSAMENTO\"\n}"}],"_postman_id":"0fa9034f-4519-42ac-a57c-399799338c8b"},{"name":"Consultar Pix","id":"e50392d3-12b5-4015-b557-daa285da9b8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/{{endtoendId}}","description":"

Endpoint para consultar um Pix através de um End to End ID.

\n","urlObject":{"protocol":"https","path":["instant-payments","pix","{{endtoendId}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"78d5faa6-7006-4666-8c9a-b8054367d963","name":"1. Consultar Pix - Com sucesso","originalRequest":{"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix/{{endtoendId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"255de164-4c46-4cd1-9dd9-179fb4280529"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"WeU6nHAvmjQFUvw="},{"key":"x-amzn-Remapped-Date","value":"Mon, 23 Nov 2020 18:39:25 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"140"},{"key":"date","value":"Mon, 23 Nov 2020 18:39:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"endToEndId\": \"E08561701202011202103DLBG8NQRK2H\",\n \"txid\": \"chco0qqa0a5512dasasdasdysgysd0012\",\n \"valor\": \"1.03\",\n \"horario\": \"2020-11-20T21:03:48Z\"\n}"}],"_postman_id":"e50392d3-12b5-4015-b557-daa285da9b8f"},{"name":"Consultar lista de pix recebidos","id":"b4fc659a-bc89-4750-8d90-c75f05ab3c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix?fim=2020-12-31T15:25:59.411Z&inicio=2020-09-11T15:25:59.411Z","description":"

Endpoint para consultar um Pix através dos parâmetros: Data inicio, data fim, txid, se existe uma devolução ou não, cpf e cnpj.

\n","urlObject":{"protocol":"https","path":["instant-payments","pix"],"host":["secure","sandbox","api","pagseguro","com"],"query":[{"key":"fim","value":"2020-12-31T15:25:59.411Z"},{"key":"inicio","value":"2020-09-11T15:25:59.411Z"}],"variable":[]}},"response":[{"id":"c1f8051b-d473-4de1-907e-464c9b6033e5","name":"Consultar lista de pix recebidos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.sandbox.api.pagseguro.com/instant-payments/pix?fim=2021-04-01T15:25:59.411Z&inicio=2021-03-11T15:25:59.411Z","protocol":"https","host":["secure","sandbox","api","pagseguro","com"],"path":["instant-payments","pix"],"query":[{"key":"fim","value":"2021-04-01T15:25:59.411Z"},{"key":"inicio","value":"2021-03-11T15:25:59.411Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"8764d49b-84d0-4f88-9a7e-b655bbccb72c"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"eCqrAGhGIAMFeFw="},{"key":"x-amzn-Remapped-Date","value":"Mon, 19 Apr 2021 17:30:46 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"914"},{"key":"date","value":"Mon, 19 Apr 2021 17:30:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"parametros\": {\n \"inicio\": \"2021-03-11T15:25:59Z\",\n \"fim\": \"2021-04-01T15:25:59Z\",\n \"paginacao\": {\n \"paginaAtual\": 0,\n \"itensPorPagina\": 100,\n \"quantidadeDePaginas\": 1,\n \"quantidadeTotalDeItens\": 4\n }\n },\n \"pix\": [\n {\n \"endToEndId\": \"727f79e2dfbe410ab4356be6a49b3e53\",\n \"txid\": \"TesteTxId1234567891011121314151785\",\n \"valor\": \"1.02\",\n \"horario\": \"2021-03-23T17:02:51Z\"\n },\n {\n \"endToEndId\": \"0adb0d6efc854ee8ae2cecdb3e1b0f00\",\n \"txid\": \"TesteTxId1234567891011121314157514\",\n \"valor\": \"1.04\",\n \"horario\": \"2021-03-23T18:06:37Z\",\n \"devolucoes\": [\n {\n \"id\": \"258746\",\n \"rtrId\": \"D08561701202103231815NKZ0HONQCVE\",\n \"valor\": \"1.04\",\n \"horario\": {\n \"solicitacao\": \"2021-03-23T18:15:59Z\"\n },\n \"status\": \"DEVOLVIDO\"\n }\n ]\n },\n {\n \"endToEndId\": \"0a24552183c849cb8a073b6ae637b309\",\n \"txid\": \"TesteTxId1234567891011121314157894\",\n \"valor\": \"1.05\",\n \"horario\": \"2021-03-23T19:52:14Z\"\n },\n {\n \"endToEndId\": \"5de645ecec3f455295b7badacdf865bc\",\n \"txid\": \"TesteTxId1234567891011121314144444\",\n \"valor\": \"1.05\",\n \"horario\": \"2021-03-23T20:18:16Z\"\n }\n ]\n}"}],"_postman_id":"b4fc659a-bc89-4750-8d90-c75f05ab3c1a"}],"id":"bb132409-9ba0-4a23-b0c0-88f81b84827e","description":"

O recebimento é caracterizado por um conjunto de informações essenciais que são utilizadas para que um usuário recebedor consulte os seus pagamentos recebidos por meio do arranjo Pix.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Método	Campo	Tipo
PUT	Criação de Devolução	Permite criar uma devolução total
GET	Consultar PIX	Permite consultar um ou mais PIX recebidos
GET	Consultar Devolução	Permite consultar uma devolução

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b227f3d0-9949-49fe-a300-9fb68da34753"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"87556b2a-71ef-4de9-8266-e06573c7bbcd"}}],"_postman_id":"bb132409-9ba0-4a23-b0c0-88f81b84827e"},{"name":"Gerenciamento de notificações","item":[{"name":"Objeto Notificações","id":"6bce81bd-d17c-4a03-9f15-03e39b07125a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"","description":"

O gerenciamento de notificações via Webhook permite que o PSP Recebedor informe diretamente o usuário recebedor quando um recebimento ou devolução associados a uma chave de endereçamento tiverem atualizações. Para a funcionalidade de webhooks, as notificações oriundas do PSP recebedor ao usuário recebedor trafegarão utilizando um canal mTLS. \nPortanto, seguindo a recomendação do BACEN, ao enviarmos a notificação de callback nós assinaremos a requisição com as chaves pública e privada do mesmo certificado que disponibilizamos para autenticação mútua no consumo da API Pix.

Cabe à aplicação que recebe o callback validar se o certificado assinado é o mesmo disponibizado por nós para o consumo da API Pix, para garantir que a origem da requisição é segura e aceitá-la.

\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6bce81bd-d17c-4a03-9f15-03e39b07125a"},{"name":"Configurar webhook PIX","id":"7d43b29e-793e-4513-b7b2-8c0e248b560f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/{{chave}}","urlObject":{"protocol":"https","path":["instant-payments","webhook","{{chave}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"011779b4-3567-4ed2-839f-3fa29b98e6cd","name":"Configurar webhook PIX","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/{{chave}}"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7d43b29e-793e-4513-b7b2-8c0e248b560f"},{"name":"Exemplo de Callback","id":"8b694033-4eb1-4fb0-a9ec-6d570e7df37b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OBJ","header":[],"url":"https://pix.example.com/api/webhook/","description":"

Para exemplificar este cenário, segue curl com assinatura das chaves do certificado na chamada de callback para a url fictícia https://pix.example.com/api/webhook/:

curl --location --request POST 'https://pix.example.com/api/webhook/' --cert cert.pem --key cert.key

\n","urlObject":{"protocol":"https","path":["api","webhook",""],"host":["pix","example","com"],"query":[],"variable":[]}},"response":[{"id":"92975439-6570-47ef-b838-01b4193dd990","name":"Demonstração de POST para Callback - Cobrança SEM Devolução","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"devolucoes\": [],\r\n \"endToEndId\": \"E08561701202012281237WMNRYKHXAYB\",\r\n \"horario\": \"2020-12-28T09:37:59.899261\",\r\n \"txId\": \"123456789012345678901234567890003\",\r\n \"valor\": \"1200\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://pix.example.com/api/webhook/"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a78cb853-3da2-413e-8e87-67e6a03f8277","name":"Demonstração de POST para Callback - Cobrança com Devolução","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"endToEndId\": \"E08561701202012292039PFG3LWGYZVV\",\r\n \"txId\": \"8888888888888888888888888888001\",\r\n \"valor\": \"1500\",\r\n \"horario\": \"2020-12-29T17:41:28.64576\",\r\n \"devolucoes\": [\r\n {\r\n \"id\": \"callegas3\",\r\n \"rtrId\": \"D08561701202012292045NU8LEVOJUOZ\",\r\n \"valor\": \"1500\",\r\n \"horario\": {\r\n \"solicitacao\": \"2020-12-29T17:45:51.447099\",\r\n \"liquidacao\": \"2020-12-29T17:45:59.231952\"\r\n },\r\n \"status\": \"DEVOLVIDO\"\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://pix.example.com/api/webhook/"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8b694033-4eb1-4fb0-a9ec-6d570e7df37b"},{"name":"Exibir informações sobre webhook Pix","id":"75898f00-af6f-45f2-8be9-048b2084f723","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/{chave}","urlObject":{"protocol":"https","path":["instant-payments","webhook","{chave}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"7e8cbb9b-6db8-4bee-a787-fe12c840ed9a","name":"Exibir informações sobre webhook Pix","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/73fa7d23-4d83-4f44-b4eb-9eeec083b1ee"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\",\n \"chave\": \"73fa7d23-4d83-4f44-b4eb-9eeec083b1ee\",\n \"criacao\": \"2020-11-11T10:15:00.358Z\"\n}"}],"_postman_id":"75898f00-af6f-45f2-8be9-048b2084f723"},{"name":"Cancelar o webhook Pix","id":"38701d40-8adb-40bf-ba98-dee16b406055","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/{{chave}}","urlObject":{"protocol":"https","path":["instant-payments","webhook","{{chave}}"],"host":["secure","sandbox","api","pagseguro","com"],"query":[],"variable":[]}},"response":[{"id":"0fc73ad1-0258-4d0c-a333-e70d5104d4c5","name":"Cancelar o webhook Pix","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://secure.sandbox.api.pagseguro.com/instant-payments/webhook/73fa7d23-4d83-4f44-b4eb-9eeec083b1ee"},"code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"38701d40-8adb-40bf-ba98-dee16b406055"}],"id":"c7820e8f-5cb0-4174-825a-653c243af034","description":"

Endpoint para cadastro, consulta e remoção de URLs para gerenciamento de notificações.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Método	Campo	Tipo
PUT	Criação de Webhook	Permite criar um webhook para notificação
GET	Consultar Webhook	Permite consultar um webhook cadastrado
DEL	Deletar Devolução	Permite deletar um webhook previamente configurado

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1135c189-cd53-469a-88ce-c1c2aa0304f1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"071af459-f6b0-40fc-87bc-f5b1542e0a6a"}}],"_postman_id":"c7820e8f-5cb0-4174-825a-653c243af034"}],"id":"3322de97-b3cc-453a-81a7-b3c2e34c8016","description":"

Este documento descreve a API PIX, que padroniza serviços oferecidos por PSPs recebedores no contexto de geração de cobranças, recebimentos, conciliações e devoluções de transações PIX. A API PIX viabiliza o recebimento de\ncobranças de forma imediata, para por exemplo, pontos de venda em\nlojas físicas e soluções para comércio eletrônico.

A API segue os padrões determinados pelo Banco Central do Brasil.

\n\n\n\n\n\n\n\n\n\n\n

Documentação oficial
https://github.com/bacen/pix-api/releases/tag/2.1.0

Recursos

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Funções Disponíveis
Criação de uma Cobrança
Atualização de uma Cobrança
Consulta de uma ou mais Cobranças
Remoção de uma Cobrança
Consulta de um ou mais Recebimentos
Solicitação de Devolução Total
Consultar Devoluções
Gerenciar Notificações

Ambientes

Essa documentação aponta por padrão para o nosso ambiente de sandbox, o que significa que, para utilizá-lo você precisará de um usuário neste ambiente, bem como suas chaves de autenticação.

Nas chamadas de API, o ambiente sendo utilizado é determinado pela URL.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Ambiente	URLs
Sandbox	https://secure.sandbox.api.pagseguro.com/instant-payments
Produção	https://secure.api.pagseguro.com/instant-payments

Versão

As requests na API PIX devem ser acompanhadas da versão pertinente. A última versão que está documentada aqui é a 2.1.0, considerando os endpoints compatíveis com a 2.0.0.

QRCode

No contexto da API-PIX a geração do QRCode fica sob responsabilidade do usuário recebedor, que deve seguir o padrão BRCode especificado pelo BACEN. Manuais disponíveis em:\nhttps://www.bcb.gov.br/estabilidadefinanceira/arranjosintegrantesspb
https://www.emvco.com/emv-technologies/qrcodes/

O payload de um BR Code consiste em uma sequência de objetos “ID, tamanho, conteúdo”. O ID de um objeto é representado por dois caracteres numéricos, seguidos do tamanho, também representado por dois caracteres numéricos que indicam a quantidade de caracteres que o conteúdo deste objeto possui. Todos os caracteres após o tamanho, representam o conteúdo em sí.

Exemplo:

QR Code text

00020126830014br.gov.bcb.pix2561api.pagseguro.com/pix/v2/210387E0-A6BF-45D1-80B5-CFEB9BBCEE2F5204899953039865802BR5921Pagseguro Internet SA6009SAO PAULO62070503***63047E6D

000201\n2683\n    0014br.gov.bcb.pix\n    2561api.pagseguro.com/pix/v2/210387E0-A6BF-45D1-80B5-CFEB9BBCEE2F\n52048999\n5303986\n5802BR\n5921Pagseguro Internet SA\n6009SAO PAULO\n62070503***\n63047E6D\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Tamanho	Conteúdo	Descrição
00	02	01	Bloco inicial, padrão `1`
26	83	-	Padrão `Arranjo Pix`
00	14	br.gov.bcb.pix	GUI do arranjo Pix, padrão `br.gov.bcb.pix`
25	61	api.pagseguro.com/pix/v2/210387E0-A6BF-45D1-80B5-CFEB9BBCEE2F	Representa o Location da cobrança
52	04	8999	MCC do Recebedor
53	03	986	Representa a moeda, sempre padrão `986` que é o código do real
58	02	BR	Representa o código do País, sempre padrão `BR`
59	21	Pagseguro Internet SA	Nome do Recebedor
60	09	SAO PAULO	Cidade do Recebedor
62	07	0503***	TXId, sempre ***, no contexto do QR Code Dinâmico ele deve ser obtido do Location
63	04	7E6D	O CRC16 é uma soma de verificação (checksum) do conteúdo completo do QR Code. O checksum deverá ser calculado usando o polinômio ‘1021’ (hex) e valor inicial ‘FFFF’ (hex). O checksum deverá ser calculado considerando todo o conteúdo do payload do QR Code, seus IDs, Tamanhos e Conteúdos, em ordem, assim como o ID e Tamanho do próprio CRC, porém desconsiderando o seu conteúdo, que é o cálculo em sí.

","event":[{"listen":"prerequest","script":{"id":"41a0e6ee-c8bf-4d5b-960d-f698dcb62e9b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c75415e7-ce4e-4632-ac73-0fd35bb45f6f","type":"text/javascript","exec":[""]}}],"_postman_id":"3322de97-b3cc-453a-81a7-b3c2e34c8016"},{"name":"Webhooks","item":[{"name":"1. Evento transacional: Charge paga","id":"d9a68428-9510-47ba-8ccc-5245a6b772d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-authenticity-token","value":"{{token-de-autenticacao-da-notificacao}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CHAR_992582af-febf-44fb-994b-81cd00b743b0\",\n \"reference_id\": \"ref0001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"paid_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"description\": \"Pagamento de teste\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"MASTERCARD\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"02\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Nome Sobrenome\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://seusite.com.br/recebimento-de-notificacao","description":"

Exemplo de uma notificação transacional enviado pelo PagSeguro para sua URL de notificação.

\n","urlObject":{"protocol":"https","path":["recebimento-de-notificacao"],"host":["seusite","com","br"],"query":[],"variable":[]}},"response":[{"id":"84116975-8827-449f-8ebe-3196fcce31d6","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-authenticity-token","value":"{{token-de-autenticacao-da-notificacao}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CHAR_992582af-febf-44fb-994b-81cd00b743b0\",\n \"reference_id\": \"ref0001\",\n \"status\": \"PAID\",\n \"created_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"paid_at\": \"2019-08-19T18:09:45.294-03:00\",\n \"description\": \"Pagamento de teste\",\n \"amount\": {\n \"value\": 500,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 500,\n \"paid\": 500,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": \"20000\",\n \"message\": \"SUCESSO\"\n },\n \"payment_method\": {\n \"type\": \"CREDIT_CARD\",\n \"installments\": 1,\n \"capture\": true,\n \"card\": {\n \"brand\": \"MASTERCARD\",\n \"first_digits\": \"411111\",\n \"last_digits\": \"1111\",\n \"exp_month\": \"02\",\n \"exp_year\": \"2026\",\n \"holder\": {\n \"name\": \"Nome Sobrenome\"\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CAPTURE\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/capture\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://api.pagseguro.com/charges/992582af-febf-44fb-994b-81cd00b743b0/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://seusite.com.br/recebimento-de-notificacao"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d9a68428-9510-47ba-8ccc-5245a6b772d4"},{"name":"2. Evento pós-transacional: Charge disponível","id":"54833a56-6f15-4840-b9d8-36e387cfd7dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"notificationCode","value":"766B9C-AD4B044B04DA-77742F5FA653-E1AB24","description":"

Identificador PagSeguro da operação

\n","type":"text"},{"key":"notificationType","value":"transaction","description":"

Tipo de operação

\n","type":"text"}]},"url":"https://seusite.com.br/recebimento-de-notificacao","description":"

Exemplo de uma notificação pós-transacional enviado pelo PagSeguro para sua URL de notificação, após receber essa primeira notificação você deve realizar uma requisição de consulta ao PagSeguro para obter o conteúdo da notificação.

\n","urlObject":{"protocol":"https","path":["recebimento-de-notificacao"],"host":["seusite","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"54833a56-6f15-4840-b9d8-36e387cfd7dd"},{"name":"3. Evento pós-transacional: Charge disponível","id":"e7b815d7-6102-4707-94af-431a5ebc8318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://ws.pagseguro.uol.com.br/v3/transactions/notifications/{{notificationCode}}?email={{email_conta_pagseguro}}&token={{token_api}}","description":"

Exemplo do contéudo de uma notificação pós-transacional recuperada por você no serviço do PagSeguro.

Veja o detalhamento de cada parâmetro nessa outra sessão que preparamos para você .

\n","urlObject":{"protocol":"https","path":["v3","transactions","notifications","{{notificationCode}}"],"host":["ws","pagseguro","uol","com","br"],"query":[{"description":{"content":"

E-mail principal cadastrado em sua cionta PagSeguro

\n","type":"text/plain"},"key":"email","value":"{{email_conta_pagseguro}}"},{"description":{"content":"

Token de API referente a sua conta PagSeguro

\n","type":"text/plain"},"key":"token","value":"{{token_api}}"}],"variable":[]}},"response":[{"id":"43e6160e-e432-46ea-b15c-b49806e9307e","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"url":{"raw":"https://ws.pagseguro.uol.com.br/v3/transactions/notifications/766B9C-AD4B044B04DA-77742F5FA653-E1AB24\n?email=email-lojista@seusite.com.br&token={{token_api}}","protocol":"https","host":["ws","pagseguro","uol","com","br"],"path":["v3","transactions","notifications","766B9C-AD4B044B04DA-77742F5FA653-E1AB24\n"],"query":[{"key":"email","value":"email-lojista@seusite.com.br","description":"E-mail principal cadastrado em sua cionta PagSeguro"},{"key":"token","value":"{{token_api}}","description":"Token de API referente a sua conta PagSeguro"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\n 2019-08-19T18:10:02.000-03:00\n 992582AF-FEBF-44FB-994B-81CD00B743B0\n 1\n 4\n 2019-09-18T03:31:52.000-03:00\n \n 1\n 102\n \n 5.00\n 0.00\n \n 0.00\n 0.40\n 0.20\n \n 4.40\n 0.00\n 2019-09-18T01:00:00.000-03:00\n 1\n 1\n \n \n 1\n Web\n 1\n 5.00\n \n \n \n PUB********************************\n \n"}],"_postman_id":"e7b815d7-6102-4707-94af-431a5ebc8318"}],"id":"209355ec-a9d4-4228-8c6d-81e0db11002a","description":"

Configurando o recebimento de notificação

Eventos transacionais

Veja a ilustração desse fluxo abaixo:\n $\"Eventos$

Cartão de crédito

AUTHORIZED
PAID
DECLINED
CANCELED

Boleto bancário

WAITING
PAID
CANCELED

Eventos pós-transacionais

Veja a ilustração desse fluxo abaixo:\n $\"Eventos$

Mudanças de status

1 - Aguardando pagamento
2 - Em análise
3 - Paga
4 - Disponível
5 - Em disputa
6 - Devolvida
7 - Cancelada
8 - Debitado
9 - Retenção temporária

Atenção: veja com mais detalhes de como essa notificação funciona aqui.

\n","event":[{"listen":"prerequest","script":{"id":"110cc1a1-683a-44c5-acfe-46c08487d089","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94c6fb50-65f8-4e0f-a0d4-671abbcb1490","type":"text/javascript","exec":[""]}}],"_postman_id":"209355ec-a9d4-4228-8c6d-81e0db11002a"}],"event":[{"listen":"prerequest","script":{"id":"9809afcd-0ae5-40bf-b33b-9ca757b8075c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b012b722-af95-40da-8a3c-b654ffa85295","type":"text/javascript","exec":[""]}}]}