Developers · Sandbox QA

Integre a API da Coloca, passo a passo.

Tudo começa no QA, nosso sandbox: um ambiente de testes separado da produção, onde nada movimenta dinheiro real. Você cria sua conta, verifica sua organização, pede suas API keys e constrói sua integração com a documentação como guia.

Documentação

A documentação da API é o seu guia.

Lá está tudo para integrar: como se autenticar, cada endpoint com exemplos de request e response, e os códigos de erro. Você pode testar os endpoints na própria página. Deixe-a aberta em cada passo.

  • Início rápido
  • Autenticação com x-api-key
  • Verificação da conta
  • Recebimentos (payins) e envios (payouts)
  • Carteiras, cotações e swaps
  • Cartões e identidades
  • Webhooks
Como começar

Cinco passos, do cadastro à revisão técnica.

Faça-os em ordem: cada passo desbloqueia o seguinte. Tudo acontece no QA, então você pode testar sem medo.

01Painel QA

Crie sua conta no sandbox

Acesse app.qa.colocapayments.com e escolha Registrar-se. O cadastro cria sua organização e seu usuário, que fica como administrador.

  • Preencha o formulário com seus dados e os da sua empresa.
  • Você recebe um código de 6 dígitos por e-mail: digite-o para confirmar seu endereço.
  • Sua equipe não precisa se cadastrar: depois você os convida em Configurações → Acesso e permissões.

O QA é independente da produção: mesmo que você já tenha conta em produção, crie uma nova no QA. Recomendado: ative a autenticação de dois fatores (2FA) em Configurações → Segurança.

02Verificação

Verifique sua organização (KYC/KYB)

Sua organização é verificada uma única vez, pelo painel. No QA a verificação é simplificada: você não precisa enviar documentos.

  • No painel, toque em Verificar agora e escolha como se verificar: como pessoa (KYC) ou como empresa (KYB).
  • Complete o fluxo guiado até que sua organização fique VERIFIED.
  • Enquanto isso, você já pode ativar carteiras, receber dinheiro e converter; para enviar dinheiro (payouts) é preciso estar VERIFIED.
03E-mail

Peça para habilitarmos suas API keys

A criação de API keys vem desativada, também no QA. Escreva para hello@colocapayments.com e nós a ativamos para sua organização: no sandbox ela é habilitada na hora, sem revisão prévia.

  • Escreva a partir do mesmo e-mail que você usou no cadastro do QA.
  • Conte o nome da sua organização e o que você vai integrar: recebimentos, envios, cartões…
  • Respondemos no mesmo e-mail quando estiver ativa. O botão abaixo deixa o e-mail pronto.
04API

Crie sua API key e integre

Com a criação ativada, gere sua chave no painel e construa sua integração contra o sandbox, seguindo a documentação.

  • Em Configurações → Acesso e permissões → API Keys, crie uma chave apenas com as permissões (scopes) de que você precisa.
  • Copie-a assim que criá-la: ela é exibida uma única vez. Guarde-a em um gerenciador de segredos, nunca no frontend nem em um repositório.
  • Envie-a no header x-api-key de cada requisição (não como Bearer). Base URL do QA: https://api.qa.colocapayments.com/api/v1.
  • Comece por GET /public/account/verification: ele confirma seu status e quais operações estão habilitadas.
Sua primeira chamada
curl https://api.qa.colocapayments.com/api/v1/public/account/verification \
  -H "x-api-key: $COLOCA_API_KEY"
Boas práticas desde o primeiro dia
  • Envie Idempotency-Key em toda operação que movimenta dinheiro, para não duplicá-la se você tentar de novo.
  • Trate os erros pelo campo code, não pelo texto da mensagem (por exemplo, organization_verification_required).
  • Configure seu webhook e valide o segredo x-secret em cada notificação.
05Meet

Agende sua revisão técnica

Quando seu fluxo funcionar de ponta a ponta no QA, agende uma reunião pelo Meet com nossa equipe técnica e mostre sua integração funcionando.

Antes de agendar, confirme que:

  • Sua organização no QA está verificada e seu fluxo principal funciona de ponta a ponta.
  • Você usa Idempotency-Key nas operações que movimentam dinheiro e trata bem as novas tentativas.
  • Você trata os erros por code: validação, saldo insuficiente, verificação exigida, limites de valor.
  • Seu webhook está configurado, passa no teste de conexão e valida x-secret.
  • Suas API keys estão guardadas com segurança e têm apenas as permissões necessárias.
  • Você consulta o status das operações (endpoints de consulta ou webhooks), sem depender só da resposta inicial.

Na reunião você nos mostra seus casos de uso funcionando, o tratamento de erros, a idempotência, os webhooks e como protege suas API keys. Se for aprovada, você fica pronto para a produção; se houver observações, nós as compartilhamos e agendamos outra revisão.

Depois da revisão

A passagem para produção.

Com estas duas aprovações, ativamos a criação de API keys na sua conta de produção, onde sua organização também precisa estar cadastrada e verificada:

  1. 1Sua revisão técnica, aprovada.
  2. 2A proposta comercial, aprovada: ela define as condições e os custos de operação.

Depois você cria suas API keys de produção e configura a base URL e o webhook de produção. Recomendado: restrinja os IPs permitidos, defina vencimentos e faça a rotação das chaves periodicamente.

AmbientePainelAPI (base URL)Para quê
Sandbox (QA)app.qa.colocapayments.comapi.qa.colocapayments.com/api/v1Testes, sem dinheiro real
Produçãoapp.us.colocapayments.comapi.us.colocapayments.com/api/v1Operação real

As chaves e a configuração do QA não funcionam em produção, nem o contrário: use chaves diferentes em cada ambiente.

Comece hoje no sandbox.

Crie sua conta no QA e tenha a documentação à mão desde a sua primeira chamada.

Dúvidas em algum passo? Escreva para hello@colocapayments.com