Introdução à API

O que a API faz, o que precisa estar ativo antes da primeira cobrança e por onde começar.

A API expõe o PIX do portal. Com ela a revenda cria cobranças, consulta o pagamento, simula o pagamento no sandbox e estorna uma cobrança já paga.

Antes da primeira chamada:

1. A revenda tem a carteira PIX ativa.
2. A empresa que vai emitir o PIX também tem a carteira PIX ativa, com domicílio bancário da própria empresa.
3. Você tem a chave do integrador e autenticou com o CNPJ da empresa que emite o PIX. Empresa sem revenda autentica com a própria chave. Empresa de uma revenda precisa estar associada a essa revenda. A revenda autentica o próprio CNPJ, sem precisar de vínculo consigo mesma.

Autenticação

Monte o segredo, troque por um JWT e envie esse JWT em Authorization.

Ambientes

Ambiente	Base	Para quê
Sandbox	https://sandboxapi.mycredit.com.br	Integrar e testar. O QR Code não é pago por um banco real. Use a simulação de pagamento.
Produção	https://mycreditapi.azurewebsites.net	Cobranças reais. O pagador paga o QR Code no banco. Não existe simulação.

Fluxo de uma cobrança

1. Autenticar

   GET /api/token/{segredoBase64} devolve o JWT.

2. Criar o PIX

   POST /api/pix com o idFaturaPag gerado pela sua aplicação. Sem dataVencimento, o PIX é imediato e expira em cerca de 10 minutos. Com dataVencimento (YYYY-MM-DD), a cobrança vence nessa data. A resposta traz o código copia e cola em data.retUrl.

3. Saber se pagou

   GET /api/pix/{idFaturaPag}. Enquanto estiver pendente, a API responde 410. Quando o pagamento entra, responde 200.

   Se a revenda configurou a URL de callback, o MyCredit também envia o evento pix.pago. A consulta continua sendo a confirmação se o evento não chegar.

4. No sandbox, simular o pagamento

   POST /api/pix/simular-pagamento/{idFaturaPag}. Só existe no sandbox. O MyCredit confirma a cobrança somente se a Fiserv aprovar a simulação.

5. Estornar, se precisar

   DELETE /api/pix/{idFaturaPag} devolve o valor integral de uma cobrança já paga. Estorno parcial não existe nesta API: ele é feito no portal.

Guarde o idFaturaPag que você enviou na criação. Ele é a chave da consulta, da simulação e do estorno.