{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"be9c248c-918b-43a7-9591-ff1de5558107","name":"PayVip API 360","description":"# ✅Introdução\n\nA **PayVip** permite que você desenvolva de forma rápida, simples e com poucas linhas de código as melhores soluções em **automação financeira e divisão inteligente de pagamentos (split)**.\n\nNossa tecnologia e infraestrutura financeira possibilita criar soluções de **pagamentos, contas digitais e conciliação automática** sem burocracia.\n\n### 🛡️ Segurança e conformidade\n\nA infraestrutura segue o mais alto padrão de segurança, garantindo a proteção total dos dados de cartões e transações.\n\nToda a tecnologia é **100% aderente às regulações do Banco Central** e ao sistema de pagamentos brasileiro (SPB).\n\n### ⚙️ Soluções integradas\n\nCom o Split PayVip, sua empresa pode oferecer:\n\n- **Aceitação de pagamentos online e presencial** \n Receba via cartão, Pix ou boleto com divisão automática entre participantes.\n \n- **Gestão de contas digitais** \n Crie e gerencie contas de clientes, parceiros e fornecedores dentro da sua plataforma.\n \n- **Controle inteligente de recebíveis** \n Antecipe, divida e acompanhe repasses em tempo real.\n \n\n### 🚀 Ganhe agilidade com o Split PayVip\n\nCom o Split PayVip, você reduz drasticamente seu **time-to-market** e entra no mercado financeiro **sem precisar lidar com regulamentações complexas ou infraestrutura bancária**.\n\nFoque no seu produto — nós cuidamos do split, dos repasses, da segurança e da conformidade.\n\n\n\n# 🔐 Requisitos de Segurança\n\nOs requisitos vem com o propósito de melhorar a segurança com acesso à plataforma PayVip, visando mitigar os riscos de ataques cibernéticos, exigindo a implementação de controles mínimos de segurança independente da tecnologia utilizada pelo parceiro (Web, Mobile ou Application), tendo o cliente como responsável a implementação dos seguintes requisitos mínimos em sua plataforma:\n\nTransporte\n\n- Todas as comunicações entre o cliente o a plataforma devem ocorrer por HTTPS usando a versão a partir do TLS 1.2.\n \n- Todas as interfaces acessíveis ao público na internet, devem usar um Certificado Digital que tenha sido assinado por uma autoridade de certificação aprovada e legítima.\n \n- Sempre que possível crie uma lista de permissões de IP’s (WhiteList) para limitar e controlar o acesso apenas de recursos autorizados.\n \n- Sempre que possível, utilize soluções para controlar o acesso da rede como Firewall e WAF (Web Application Firewall).\n \n\n⚠️ **Importante:**\n\nAs chaves de API fornecidas pela PayVip **devem ser utilizadas apenas com TLS habilitado**. Nunca inclua essas chaves na URL ou em strings de consulta, pois podem ser armazenadas de forma não segura por navegadores ou servidores, expondo suas credenciais. Sempre envie as chaves no **cabeçalho HTTP**.\n\nAlém disso, **evite o uso de URLs curinga** (por exemplo, `Access-Control-Allow-Origin:\\*`) nos cabeçalhos de resposta, exceto em casos onde o recurso REST seja público e não exija autenticação.\n\n---\n\n# 🌐 Design da API\n\nA API PayVip 360 foi desenvolvida seguindo os princípios RESTful, com recursos orientados por URLs e uso de códigos HTTP para indicar o status das operações. Os verbos HTTP utilizados são:\n\n- `POST` – criação de recursos\n \n- `PUT` – atualização de recursos\n \n- `GET` – leitura de dados\n \n- `DELETE` – remoção de recursos\n \n\nTodas as respostas da API são retornadas em **formato JSON**, incluindo mensagens de erro.\n\n---\n\n# 🌍 CORS e Integração Web\n\nA API suporta **CORS (Cross-Origin Resource Sharing)**, permitindo chamadas seguras a partir de aplicações web hospedadas em domínios diferentes. Isso facilita a integração com sistemas externos e aplicações frontend.\n\n# 💳Bandeiras Aceitas\n\n\n\nOs seguintes números de cartão de crédito podem ser usados para simular transações em ambiente de teste (sandbox), para pagamentos bem-sucedidos:\n\n| **Número** | **Bandeira** |\n| --- | --- |\n| 4539003370725497 | Visa (Digitada) |\n| 4761340000000035 | Visa (Chip & PIN) |\n| 4716588836362104 | Visa (Crédito) |\n| 4532650104137832 | Visa Electron (Crédito) |\n| 5356066320271893 | MasterCard (Digitada) |\n| 5201561050024014 | MasterCard (Chip & PIN) |\n| 5577270004286630 | MasterCard (Crédito) |\n| 5138692036125449 | MasterCard (Crédito) |\n\nAlém disso, esses são os números \"mágicos\" de cartões que gerarão respostas específicas, úteis para testar diferentes cenários:\n\n| **Número** | **Bandeira** |\n| --- | --- |\n| 6011457819940087 | A transação será recusada com um código de \"card_declined\". |\n| 4929710426637678 | A transação será recusada com um código \"card_declined\". |\n| 4710426743216178 | A transação será recusada com um código \"service_request_timeout\". |\n\n# ❌Códigos de erro\n\n##### Códigos de Status HTTP\n\nEm poucas palavras, existem apenas 3 resultados na interação entre seu aplicativo e nossa API:\n\n- Tudo funcionou\n \n- O aplicativo fez algo errado\n \n- A API fez algo errado\n \n\nA **API PayVip 360** tenta retornar códigos de status de resposta HTTP apropriados para cada solicitação.\n\nEm geral, os códigos no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro necessário faltou, uma transação falhou, etc.) e os códigos no intervalo 5xx indicam um erro com os servidores da PayVip.\n\nA tabela a seguir contém os valores mais comuns para os códigos de status HTTP retornados pela API:\n\n| HTTP STATUS CODE | Texto | Descrição |\n| --- | --- | --- |\n| 200 | OK | Tudo funcionou conforme o esperado. |\n| 201 | Created | A requisição foi bem sucedida e um novo recurso foi criado. |\n| 304 | Not Modified | Não havia dados novos para retornar. |\n| 400 | Bad Request | A requisição foi invalida ou não atingiu o servidor. Muitas vezes, falta um parâmetro obrigatório. |\n| 401 | Unauthorized | As credenciais de autenticação estavam faltando ou foram incorretas. |\n| 402 | Request Failed | Os parâmetros foram válidos mas a requisição falhou. |\n| 403 | Forbidden | A requisição foi ok, mas foi recusado ou o acesso não foi permitido. Uma mensagem de erro que acompanha a mensagem explica o porquê. |\n| 404 | Not Found | A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído. |\n| 500 | Internal Server Error | Algo está quebrado. Por favor, assegure-se de que a equipe Zoop esteja investigando. |\n| 502 | Bad Gateway | A PayVip caiu ou está sendo atualizada. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3966623","team":1216140,"collectionId":"be9c248c-918b-43a7-9591-ff1de5558107","publishedId":"2sB3WjyiR3","public":true,"publicUrl":"https://docs.payvip.app","privateUrl":"https://go.postman.co/documentation/3966623-be9c248c-918b-43a7-9591-ff1de5558107","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"API 360 PayVip"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-10-24T13:57:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API 360 PayVip","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f80a404d730d400cad74475bcdee60ebd1137cb668b2fb74d3cb010167497405","favicon":"https://payvip.app/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.payvip.app/view/metadata/2sB3WjyiR3"}