{"info":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","description":"

Documentação destinada a desenvolvedores interessados no produto de cartões de débito PagueVeloz.

Se você ainda não tem acesso à essa funcionalidade pelo Painel PV > Cartões Pagueveloz:

Em homologação: entre em contato com o suporte PV;
Em produção: entre em contato com seu gerente comercial.

Nas APIs abaixo, qualquer menção ao parâmetro Id ou CartaoDebitoId é referente ao campo Id obtido no endpoint Listagem.\nE onde mencionar Número do Cartão significa o número impresso no cartão, ou seja, o cartão físico.

Em homologação alguns endpoints retornarão um mock, como o endpoint de extrato.

Ambientes de Integração

Produção: https://www.pagueveloz.com.br/api
Homologação: https://sandbox.pagueveloz.com.br/api

Headers

São necessários 2 headers na requisição de qualquer função.

Content-Type: application/json

Authorization: Basic ZW1haWxAZG9taW5pby5jb206YWJjZGVm

Autenticação

A autenticação ocorre através do header “Authorization” que é composto pela palavra Basic sucedida pelo email e token separados por dois pontos codificado com UTF8 em base64.

Exemplo: email@dominio.com:abcdef

Authorization: Basic ZW1haWxAZG9taW5pby5jb206YWJjZGVm

É possível testar a autenticação no endpoint https://pagueveloz.com.br/api/v1/ping/autenticado.\nSe foi implementada corretamente, retornará 200 OK.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Ambientes de Integração","slug":"ambientes-de-integracao"},{"content":"Headers","slug":"headers"},{"content":"Autenticação","slug":"autenticacao"}],"owner":"1552073","collectionId":"e45a7988-b5c8-425b-994f-10d9fdf034d2","publishedId":"RznFqJqo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-01-10T12:51:09.000Z"},"item":[{"name":"Solicitar Cartão","id":"5e2e0e7c-86f0-4e51-8239-428c3c8273f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"NomeCompleto\": \"Rebecca Nurse\",\r\n \"NomeMaeCompleto\": \"Abigail Williams\",\r\n \"DataNascimento\": \"1621-02-21\",\r\n \"Documento\": \"97628720021\",\r\n \"ValorCarga\": 10.0,\r\n \"Endereco\": {\r\n \"CEP\": \"00000000\",\r\n \"Bairro\": \"Centro\",\r\n \"Logradouro\": \"Rua Centro\",\r\n \"Numero\": \"100\",\r\n \"Complemento\": \"\",\r\n \"Cidade\": {\r\n \"Nome\": \"Blumenau\",\r\n \"Estado\": \"SC\"\r\n }\r\n },\r\n \"Contato\": {\r\n \"TelefoneResidencial\": \"4733556677\",\r\n \"TelefoneCelular\": \"47999887766\",\r\n \"Email\": \"rebecca@nurse.com\"\r\n }\r\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/SolicitarCartao","description":"

Solicita um novo cartão de débito. O cartão será gerado e enviado para o endereço informado dentro de 15 dias úteis. É necessário informar uma recarga inicial durante o processo, o valor mínimo sendo R$ 1,00. Portanto o custo de um cartão de débito é:\n Tarifa de Solicitação + Tarifa de Recarga + Saldo Inicial

As tarifas utilizadas são as que estão configuradas na Conta que está fazendo a integração.

Logo que um novo cartão é solicitado ele já aparecerá na listagem de cartões, porém com o status Cadastrando. Neste estado não há como ativar, recarregar o cartão ou realizar qualquer ação.

Após algums momentos (geralmente de 1~2 minutos) o cartão será efetivamente emitido e aparecerá na listagem de cartões com o status Inativo, indicando que ele será entregue no endereço indicado e está esperando ativação.

Em homologação não será gerado cartões físicos.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","SolicitarCartao"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e2e0e7c-86f0-4e51-8239-428c3c8273f4"},{"name":"Listagem (Sem Saldo)","id":"829f7b1f-915f-4e48-8e23-4d4794e9e94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito","description":"

Lista de todos os cartões vinculados ao cliente, não excluídos. Como este endpoint não retorna os saldos juntos ele é mais eficiente e é recomendado em relacação ao endpoint Listagem com Saldo. \nA ação recomendada para sistemas web é fazer o carregamento da Listagem, e após a requisição ter sido feito, fazer uma requisição paralela para cada cartão que desejar obter o saldo, no endpoint Obter Saldo.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"829f7b1f-915f-4e48-8e23-4d4794e9e94c"},{"name":"Listagem (Com Saldo)","id":"ff1a0dcd-8b63-4c58-84fe-8e839aed1ccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/ListagemComSaldo","description":"

Esse retorno possui o saldo junto com as informações cadastrais dos cartões. \nNão é recomendado seu uso devido a demora de obter o saldo dependendo da quantidade de cartões. Porém seu uso pode ser interessante em ambientes mobile, assim evitando fazer várias requisições.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","ListagemComSaldo"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff1a0dcd-8b63-4c58-84fe-8e839aed1ccb"},{"name":"Obter Saldo","id":"eca69edc-8473-49d1-a7b6-49ff5acee351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.pagueveloz.com.br/api/v2/CartaoDebito/Consultar/Saldo/{Id}","description":"

Obtém o saldo do cartão. Deve ser passado como parâmetro o Id do cartão, que pode ser obtido do parâmetro Id no endpoint Listagem.

O saldo em ambiente de sanbbox é estático e igual para todos os cartões. Créditos em sandbox não alterarão esse valor.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v2","CartaoDebito","Consultar","Saldo","{Id}"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"eca69edc-8473-49d1-a7b6-49ff5acee351"},{"name":"Extrato ","id":"9bbb4269-3bdf-4f04-a9e9-01de60809c84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/Extrato?numeroCartao={numeroCartao}&cartaoDebitoId={Id}&dataInicial={dataInicial}&dataFinal={dataFinal}","description":"

O intervalo entre as datas de ínicio e finais não deve ultraprassar 90 dias. Registros de extratos antigos (+1 ano) podem não estar disponíveis para consulta por este endpoint. Para identificar o cartão que deve ter o extrato buscado, pode ser passado tanto o número do cartão (número que aparece no cartão físico) ou o CartaoDebitoId (que pode ser obtido no endpoint Listagem, com o nome Id).

Nas Apis de Cartão de Débito o campo que sempre é utilizado é o Id, a não ser quando comentado o contrário na documentação do endpoint. Onde a API requisitar um Id ou CartaoDebitoId na api, deve-se usar o campo Id desde endpoint para identificar o cartão.

O extrato em ambiente de sandbox é estático e é o mesmo valor para todos os cartões.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","Extrato"],"host":["sandbox","pagueveloz","com","br"],"query":[{"key":"numeroCartao","value":"{numeroCartao}"},{"key":"cartaoDebitoId","value":"{Id}"},{"key":"dataInicial","value":"{dataInicial}"},{"key":"dataFinal","value":"{dataFinal}"}],"variable":[]}},"response":[],"_postman_id":"9bbb4269-3bdf-4f04-a9e9-01de60809c84"},{"name":"Creditar","id":"f58113b3-b24e-4d0c-adc5-8fcb90e968fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Id\": 1\n\t\"Valor\": 12.13\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/Creditar","description":"

Faz o crédito de um cartão de débito do usuário. O parâmetro \"Id\" passado é o campo Id, que pode ser obtido no endpoint Listagem.

Se o cartão já possuir uma recarga em processamento, será retornado 400 BadRequest (\"Já existe uma recarga em processamento para este cartão.\")

O custo de uma recarga é: Valor da Recarga + Tarifa de Recarga

O retorno:

{\n    \"Id\": 123,\n    \"Valor\": 12.14,\n    \"Data\": \"31/12/2018\"\n}\n

IMPORTANTE: O crédito não é efetuado no exato momento que a requisição retornar OK 200. A recarga entrará em uma fila de processamento e será processada posteriormente. Geralmente demora cerca de 1~2 minutos para a recaga ser processada.

Permite obter o status e datas de solicitação e processamento de recargas efetuadas nos cartões de débitos vinculadas a esse cliente.

O Id a ser utilizado é o ID retornado na API POST /Creditar\nO retorno:

{\n    \"Valor\": -20,\n    \"Status\": \"Processado\",\n    \"Solicitacao\": \"23/11/2018\",\n    \"Processamento\": \"23/11/2018\"\n}\n

Os status são:\nProcessado: Carga entrou com sucesso no cartão\nEmProcessamento: Carga solicitada, ainda não está no cartão\nCancelada: Apenas acontece em interverções manuais e pontuais

Repete o último Crédito feito no cartão se o Cliente possuir saldo suficiente. Parâmetro passado é o Id do cartão que pode ser obtido no endpoint Listagem.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","{Id}","RepetirUltimoCredito"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"45e9dfcc-ed3f-4279-a214-392281604348"},{"name":"Creditar Todos","id":"38774707-4f46-4c94-9ac7-bc606dd2f7ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Valor\": 3.50\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/RecarregarTodos","description":"

Credita todos os cartões do cliente que:

Estivem ativos;
Não estiverem excluídos.

O valor passado como parâmetro para o crédito é creditado em todos os cartões aplicáveis de acordo com a regra acima.

Se o cliente não possuir saldo para creditar todos os cartões ao mesmo tempo, nenhum deles será creditado.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","RecarregarTodos"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"38774707-4f46-4c94-9ac7-bc606dd2f7ad"},{"name":"Transferência de Saldo entre Cartões","id":"1466dc9d-faab-42ab-bc24-5f4f96edc860","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CartaoDebitoIdOrigem\": 1,\r\n \"CartaoDebitoIdDestino\": 2,\r\n \"Valor\": 3.0\r\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/TransferirSaldoEntreCartoes","description":"

É possível transferir o saldo entre cartões do mesmo Cliente. Para isso acontecer:

O cartão origem deve ter o saldo estipulado para a transferência;
O cartão destino deve estar Ativo ou Inativo;
Os cartões devem ser do mesmo Cliente.

Ambos os Ids passados no body podem ser obtidos no endpoint Listagem.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","TransferirSaldoEntreCartoes"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1466dc9d-faab-42ab-bc24-5f4f96edc860"},{"name":"Ativar (Com Número e Data de Nascimento)","id":"c8bc10f0-cb40-4a47-9bf9-f7c9632cf697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"DataNascimento\": \"1990-01-01\",\n\t\"Senha\": \"1234\"\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/{numeroCartao}/Ativar","description":"

A senha do cartão deve conter 4 dígitos com valor numérico. Neste endpoint é necessário o número do cartão físico e a data de nascimento do portador. Esse endpoint deve ser utilizado quando apenas o próprio portador do cartão pode ativar seu cartão.

Em ambiente de Homologação, deve ser passado o Id do cartão ao invés do número do cartão, sendo que em homologação não existem cartões físicos.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","{numeroCartao}","Ativar"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8bc10f0-cb40-4a47-9bf9-f7c9632cf697"},{"name":"Ativar (Com Id)","id":"0da3729d-1753-43b5-9cb3-eb2cb6bd87e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Senha\": \"1234\"\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/{Id}/AtivarComId","description":"

A senha do cartão deve conter 4 dígitos com valor numérico. Neste endpoint é necessário passar o Id apenas (que pode ser obitdo no endpoint Listagem). Esse endpoint deve ser utilizado quando o integrador desejar ativar o cartão do cliente sem a necessidade de interação do mesmo.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","{Id}","AtivarComId"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"0da3729d-1753-43b5-9cb3-eb2cb6bd87e1"},{"name":"Alterar Senha","id":"a40de9c9-ac4d-442a-bf8d-e0964df044d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CartaoDebitoId\": 1,\n\t\"Senha\": \"1234\"\n}"},"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/AlterarSenha","description":"

Segue a mesma regra de validação de senha do endpoint Ativar.\nAqui apenas é preciso passar no body o Id, que pode ser obtido na Listagem, e a nova senha.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","AlterarSenha"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"a40de9c9-ac4d-442a-bf8d-e0964df044d9"},{"name":"Remover","id":"a846f7d2-3e37-4263-934b-cb47ad92e9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://sandbox.pagueveloz.com.br/api/v1/CartaoDebito/{Id}","description":"

Remove o cartão logicamente. É passado como parâmetro o Id, que pode ser obtido no endpoint Listagem.

Após removido, o cartão não vai mais aparecer nos endpoints de listagem. Porém o cartão continua funcional, com o saldo intacto.

Esta ação pode ser desfeita pelo time de backoffice PagueVeloz.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","id":"e45a7988-b5c8-425b-994f-10d9fdf034d2","name":"Docs - Cartões PagueVeloz (Débito)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","CartaoDebito","{Id}"],"host":["sandbox","pagueveloz","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"a846f7d2-3e37-4263-934b-cb47ad92e9e9"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"c2cb3c29-65fb-4011-bc23-df1b86a0b516","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59febcf5-3839-42af-a9ca-9805686b26b2","type":"text/javascript","exec":[""]}}]}