Coloca
Book a demo →Open account
Developers · QA sandbox

Integrate the Coloca API, step by step.

Everything starts in QA, our sandbox: a test environment separate from production, where nothing moves real money. You create your account, verify your organization, request your API keys and build your integration with the docs as your guide.

View the docs Create a QA account
Docsapi.qa.colocapayments.com/coloca/docs/publicQA panelapp.qa.colocapayments.com
Your integration pathSandbox · QA
  1. 01Create your QA account
  2. 02Verify your organization (KYC)
  3. 03Request your API keys
  4. 04Integrate with the docs
  5. 05Book your technical review
Then: go to production
Documentation

The API docs are your guide.

Everything you need to integrate is there: how to authenticate, every endpoint with request and response examples, and the error codes. You can try the endpoints right from the page. Keep it open at every step.

  • Quick start
  • Authentication with x-api-key
  • Account verification
  • Payins and payouts
  • Wallets, quotes and swaps
  • Cards and identities
  • Webhooks
Open the docs
How to start

Five steps, from sign-up to technical review.

Do them in order: each step unlocks the next one. It all happens in QA, so you can test freely.

01QA panel

Create your sandbox account

Go to app.qa.colocapayments.com and choose Sign up. Signing up creates your organization and your user, who becomes its administrator.

  • Fill in the form with your details and your company's.
  • You'll get a 6-digit code by email: enter it to confirm your address.
  • Your team doesn't need to sign up: you invite them later from Settings → Access & permissions.

QA is separate from production: even if you already have a production account, create a new one in QA. Recommended: turn on two-factor authentication (2FA) in Settings → Security.

Create a QA account
02Verification

Verify your organization (KYC/KYB)

Your organization is verified once, from the panel. In QA the verification is simplified: you don't have to upload documents.

  • In the panel, tap Verify now and choose how to verify: as a person (KYC) or as a company (KYB).
  • Complete the guided flow until your organization shows VERIFIED.
  • Meanwhile you can already activate wallets, receive money and convert; to send money (payouts) you need to be VERIFIED.
Open the QA panel
03Email

Ask us to enable your API keys

API key creation comes disabled, in QA too. Write to hello@colocapayments.com and we'll turn it on for your organization: in the sandbox it's enabled right away, with no prior review.

  • Write from the same email you used to sign up in QA.
  • Tell us your organization's name and what you'll integrate: payins, payouts, cards…
  • We'll reply on the same thread once it's active. The button below drafts the email for you.
Email hello@colocapayments.com
04API

Create your API key and integrate

With creation enabled, generate your key in the panel and build your integration against the sandbox, following the docs.

  • In Settings → Access & permissions → API Keys, create a key with only the permissions (scopes) you need.
  • Copy it as soon as you create it: it's shown only once. Store it in a secrets manager, never in the frontend or a repository.
  • Send it in the x-api-key header of every request (not as a Bearer token). QA base URL: https://api.qa.colocapayments.com/api/v1.
  • Start with GET /public/account/verification: it confirms your status and which operations you have enabled.
Your first call
curl https://api.qa.colocapayments.com/api/v1/public/account/verification \
  -H "x-api-key: $COLOCA_API_KEY"
Good practices from day one
  • Send an Idempotency-Key on every operation that moves money, so a retry never duplicates it.
  • Handle errors by the code field, not by the message text (for example, organization_verification_required).
  • Set up your webhook and validate the x-secret on every notification.
Open the docs
05Meet

Book your technical review

Once your flow works end to end in QA, book a Meet call with our technical team and show us your integration working.

Before booking, make sure that:

  • Your QA organization is verified and your main flow works end to end.
  • You send Idempotency-Key on operations that move money and handle retries well.
  • You handle errors by code: validation, insufficient balance, verification required, amount limits.
  • Your webhook is set up, passes the connection test and validates x-secret.
  • Your API keys are stored securely and have only the permissions they need.
  • You check operation status (query endpoints or webhooks) instead of relying only on the initial response.

In the call you show us your use cases working, error handling, idempotency, webhooks and how you protect your API keys. If it's approved, you're ready for production; if there are observations, we share them with you and book another review.

Book technical review or email us at hello@colocapayments.com
After the review

Going to production.

With these two approvals we enable API key creation on your production account, where your organization must also be registered and verified:

  1. 1Your technical review, approved.
  2. 2The commercial proposal, approved: it sets the terms and operating costs.

Then you create your production API keys and set up the production base URL and webhook. Recommended: restrict allowed IPs, set expiration dates and rotate your keys regularly.

EnvironmentPanelAPI (base URL)Purpose
Sandbox (QA)app.qa.colocapayments.comapi.qa.colocapayments.com/api/v1Testing, no real money
Productionapp.us.colocapayments.comapi.us.colocapayments.com/api/v1Live operations

QA keys and settings don't work in production, and vice versa: use different keys in each environment.

Start today in the sandbox.

Create your QA account and keep the docs at hand from your very first call.

Create a QA account View the docs

Questions about any step? Email us at hello@colocapayments.com