{"info":{"_postman_id":"6f6bff77-17dd-4024-bdc2-997b140b9eb7","name":"Overpay - Documentação","description":"

Receba pagamentos online com eficiência para sua vida e seu negócio.

Homologação: https://homologacao.overpay.com.br/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31252122","collectionId":"6f6bff77-17dd-4024-bdc2-997b140b9eb7","publishedId":"2sAY546yWD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"212121","highlight":"2aaa93"},"publishDate":"2024-11-12T13:14:09.000Z"},"item":[{"name":"Authorization","item":[{"name":"Authorization","id":"a13dacc6-7fa0-4f74-92ec-3c0ef16b805b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Api","type":"text"},{"key":"OverUser","value":"Token Usuário","type":"text"},{"key":"OverPass","value":"Token Senha","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.overpay.com.br/v3/auth","description":"

Obtenha o token Authorization, OverUser e OverPass da sua API em sua conta para realizar a autenticação.

\n","urlObject":{"protocol":"https","path":["v3","auth"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"f7e89147-25e4-4324-b3d0-a2bc2ffe2269","name":"Authorization","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token API","type":"text"},{"key":"OverUser","value":"Token Usuário","type":"text"},{"key":"OverPass","value":"Token Senha","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.overpay.com.br/v3/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Authorization criado com sucesso.\",\n \"token\": \"$2y$10$Np.FZS8dGxhDOgx5lQH3beZNqdjoMmRy9EVhlqIyUsJrR02tdxU62\",\n \"expire\": \"2024-01-16 17:24:00\"\n}"}],"_postman_id":"a13dacc6-7fa0-4f74-92ec-3c0ef16b805b"}],"id":"03411a67-1ece-4173-8556-a010dc59cb52","description":"

Pegue o token da sua API em sua conta para realizar o Authorization.

\n","_postman_id":"03411a67-1ece-4173-8556-a010dc59cb52"},{"name":"Consultar","item":[{"name":"Consultar Transferência","id":"ac26b971-f17d-481a-8b82-e53b9b68775d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"codigo\":\"12345678901234567890\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/consult/transfer","description":"

O código da transferência está disponível no seu extrato. Você pode consultar qualquer transferência utilizando o código da transação correspondente.

\n","urlObject":{"protocol":"https","path":["v3","consult","transfer"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"5e5177b9-7823-4be8-80dc-a12f9d29f4c8","name":"Consultar Transferência","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"codigo\":\"401818202415015233361147800\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/consult/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Transferência encontrada com sucesso.\",\n \"remetente\": \"@remetente\",\n \"recebedor\": \"@recebedor\",\n \"valor\": \"1.00\",\n \"codigo\": \"12345678901234567890\",\n \"datahora\": \"2024-01-15 18:19:10\"\n}"}],"_postman_id":"ac26b971-f17d-481a-8b82-e53b9b68775d"},{"name":"Consultar Usuário","id":"32b6b4c2-8668-4543-9998-d16641cb5b38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"usuario\":\"@usuario\",\r\n \"documento\":\"CPF/CNPJ com Mask\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/check/user","description":"

Consulte o usuário para verificar se ele existe.

\n","urlObject":{"protocol":"https","path":["v3","check","user"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"8433b5a4-fd36-491a-b892-73331f169978","name":"Consultar Usuário","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"usuario\":\"@usuario\",\r\n \"documento\":\"CPF/CNPJ com Mask\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/check/user"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Usuário encontrada com sucesso.\",\n \"usuario\": \"@usuario\",\n \"nome\": \"John Joe\"\n}"}],"_postman_id":"32b6b4c2-8668-4543-9998-d16641cb5b38"},{"name":"Consultar Saldo","id":"3bf4c918-653c-47cc-b1df-bfad9b81a0c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/check/balance","description":"

Consultar saldo da sua conta.

\n","urlObject":{"protocol":"https","path":["v3","check","balance"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"c49095b9-175f-49a2-89c3-3a1396181990","name":"Consultar Saldo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.overpay.com.br/v3/check/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Saldo encontrado com sucesso.\",\n \"saldo\": \"10.00\"\n}"}],"_postman_id":"3bf4c918-653c-47cc-b1df-bfad9b81a0c1"}],"id":"7c241c20-3cd6-4eda-9855-5c085c899b97","description":"

Consulte Transferência, Usuário ou Saldo da sua API em sua conta para obter as informações necessárias.

\n","_postman_id":"7c241c20-3cd6-4eda-9855-5c085c899b97"},{"name":"Transferência Automática","item":[{"name":"Transferência Automática","id":"e6bd980b-f239-4dd0-8224-1f8cf164dcac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"recebedor\":\"@usuario\",\r\n \"valor\":\"1,00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/automatic/transfer","description":"

O recebedor deve ser informado no formato @usuario. O valor deve ser inserido no padrão da moeda Real, por exemplo: 1,00.

\n","urlObject":{"protocol":"https","path":["v3","automatic","transfer"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"7d74a9d8-8c84-4e7e-864f-3b1f1b203e53","name":"Transferência Automática","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"recebedor\":\"@usuario\",\r\n \"valor\":\"1,00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/automatic/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Transferência realizada com sucesso.\",\n \"remetente\": \"@remetente\",\n \"recebedor\": \"@recebedor\",\n \"valor\": \"1.00\",\n \"codigo\": \"12345678901234567890\",\n \"datahora\": \"2024-01-15 18:19:10\"\n}"}],"_postman_id":"e6bd980b-f239-4dd0-8224-1f8cf164dcac"}],"id":"9c6edd9c-7977-4db0-9f27-44851dee583e","description":"

O remetente e o recebedor devem ser informados no formato @usuario. O valor deve ser inserido no formato da moeda Real, por exemplo: 1,00.

\n","_postman_id":"9c6edd9c-7977-4db0-9f27-44851dee583e"},{"name":"Transferência com Validação","item":[{"name":"Nova Transferência","id":"84da4c24-6a8e-4367-b69f-0962d9e495f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"remetente\":\"@usuario\",\r\n \"recebedor\":\"@usuario\",\r\n \"valor\":\"1,00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/new/transfer","description":"

O remetente e o recebedor devem ser informados no formato @usuario. O valor deve ser inserido no formato da moeda Real, por exemplo: 1,00.

\n","urlObject":{"protocol":"https","path":["v3","new","transfer"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"27af3e2d-9ac7-4da2-8610-f57913a2be37","name":"Nova Transferência","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"destinatario\":\"@usuario\",\r\n \"recebedor\":\"@usuario\",\r\n \"valor\":\"1,00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/new/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Nova transferência criada com sucesso.\",\n \"validation_code\": \"472917202415011910181886601\",\n \"expire\": \"2024-01-15 17:39:00\"\n}"}],"_postman_id":"84da4c24-6a8e-4367-b69f-0962d9e495f8"},{"name":"Validar Transferência","id":"5b50270d-b47d-43b8-8c45-ab56372252b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"validation_code\":\"390017202415018551142552307\",\r\n \"validation_code_user\":\"680309\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/validate/transfer","description":"

validation_code é o código retornado pela API ao criar uma nova transferência com sucesso.
validation_code_user é o código de 6 dígitos fornecido pelo usuário remetente para validar e autorizar a transferência.

\n","urlObject":{"protocol":"https","path":["v3","validate","transfer"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"5ac5fbc0-69fa-4e78-b62f-242b71dd5563","name":"Validar Transferência","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"validation_code\":\"401818202415015233361147800\",\r\n \"validation_code_user\":\"988877\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/validate/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Transferência realizada com sucesso.\",\n \"remetente\": \"@remetente\",\n \"recebedor\": \"@recebedor\",\n \"valor\": \"1.00\",\n \"codigo\": \"12345678901234567890\",\n \"datahora\": \"2024-01-15 18:19:10\"\n}"}],"_postman_id":"5b50270d-b47d-43b8-8c45-ab56372252b2"}],"id":"72856472-9499-48ca-9934-6fb93409aa9f","description":"

O remetente e o recebedor devem ser informados no formato @usuario. O valor deve ser inserido no formato da moeda Real, por exemplo: 1,00.

\n","_postman_id":"72856472-9499-48ca-9934-6fb93409aa9f"},{"name":"Pix","item":[{"name":"Cash IN","id":"58cb6b1f-f058-44f7-88d4-8bb8c72a7fc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"split\": {\r\n \"recebedor\":\"\",\r\n \"porcentagem\":\"10\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashin","description":"

O valor deve ser superior a 0,99. O campo callbackUrl é obrigatório. Caso utilize split, é necessário informar o usuário recebedor no formato @usuario e a porcentagem destinada a ele. Um webhook será enviado para o callbackUrl quando a solicitação for aprovado.

\n","urlObject":{"protocol":"https","path":["v3","pix","cashin"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"ab5a5405-e89f-43eb-bcf7-d0b30cedef81","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"split\": {\r\n \"recebedor\":\"@overpay\",\r\n \"porcentagem\":\"10\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Pix Cash-in criado com sucesso.\",\n \"valor\": \"1.00\",\n \"datahora\": \"2025-04-30 11:50:57\",\n \"expiração\": \"1800\",\n \"codigo\": \"575011202530047571431828\",\n \"txid\": \"396a4a21c646ed813c69abb52cb0e4\",\n \"pixCopiaECola\": \"\",\n \"image_Base64\": \"\"\n}"},{"id":"01c13a52-19a4-40b1-9554-c18d03f79c2d","name":"401","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"split\": {\r\n \"recebedor\":\"\",\r\n \"porcentagem\":\"10\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashin"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0\",\n \"tipo\": \"14\",\n \"mensagens\": \"callbackUrl json não foi encontrado.\"\n}"}],"_postman_id":"58cb6b1f-f058-44f7-88d4-8bb8c72a7fc4"},{"name":"Cash OUT","id":"2b3b4b8a-fbd9-4150-87a0-23876b164e34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"chave\":\"\",\r\n \"chave_tipo\":\"\" //phone,email,cpf\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashout","description":"

O valor informado deve ser superior a 0,99. Os campos callbackUrl, chave e chave_tipo (phone, email, cpf) são obrigatórios. Um webhook será enviado para o callbackUrl quando a solicitação for aprovada ou recusada.

\n","urlObject":{"protocol":"https","path":["v3","pix","cashout"],"host":["api","overpay","com","br"],"query":[],"variable":[]}},"response":[{"id":"760e0909-be38-4a19-9280-0b0b25e7d95e","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"chave\":\"\",\r\n \"chave_tipo\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"tipo\": 1,\n \"mensagens\": \"Pix Cash-out criado com sucesso.\",\n \"valor\": \"1.00\",\n \"datahora\": \"\",\n \"codigo\": \"\",\n \"payid\": \"\"\n}"},{"id":"dccb5a62-0a9a-4c73-a072-cba71f423e29","name":"401","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token Auth","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"valor\":\"1,00\",\r\n \"callbackUrl\":\"\",\r\n \"chave\":\"\",\r\n \"chave_tipo\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.overpay.com.br/v3/pix/cashout"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0\",\n \"tipo\": \"2\",\n \"mensagens\": \"Token Authorization está inválido.\"\n}"}],"_postman_id":"2b3b4b8a-fbd9-4150-87a0-23876b164e34"}],"id":"92195309-812a-4998-a828-030c1e26c5a2","description":"

Consulte a API para operações de PIX: Cash In (depósito) e Cash Out (saque) .

\n","_postman_id":"92195309-812a-4998-a828-030c1e26c5a2"}]}