BlendFi

Postman collection

Download the partner Postman collection and the sandbox and production environments to exercise every BlendFi endpoint without writing code.

A ready-to-import Postman collection of every partner-facing BlendFi endpoint, paired with environment files that pre-configure the base URL and an api_key placeholder for your API key.

Download

  • Partner collection (JSON): every endpoint under the partner-facing prefixes (/v1/users, /v1/kyc, /v1/quotes, /v1/conversions, /v1/test_helpers, /v1/webhook_endpoints, /v1/webhook_deliveries).
  • Sandbox environment (JSON): pre-configured with baseUrl = https://api.sandbox.blendfi.com.br and a blank api_key variable.
  • Production environment (JSON): pre-configured with baseUrl = https://api.blendfi.com.br and a blank api_key variable.

Import into Postman

The fastest path:

  1. Open Postman.
  2. File → Import → Link (or drag-and-drop the downloaded files into Postman's left pane).
  3. Paste any of these URLs:
    • https://docs.blendfi.com.br/postman/blendfi-partner.postman_collection.json (the collection)
    • https://docs.blendfi.com.br/postman/blendfi-partner.sandbox.postman_environment.json (sandbox environment)
    • https://docs.blendfi.com.br/postman/blendfi-partner.production.postman_environment.json (production environment)
  4. Repeat for each file you want to import.
  5. In Postman's environment selector (top-right), pick BlendFi Core, Sandbox or BlendFi Core, Production.

Authenticate

The environment ships with a blank api_key value. Set it once, and every request in the collection picks it up via the Authorization: Bearer {{api_key}} header.

  1. Click the Environments tab in Postman's left sidebar.
  2. Open BlendFi Core, Sandbox (or Production).
  3. Paste your API key (sandbox: sk_test_…, production: sk_live_…) into api_keyCurrent Value.
  4. Save.

Get a sandbox key first

If you don't have a sandbox key yet, see Sandbox & keys for the request flow.

Walk through one request

A round-trip to confirm everything's wired up:

  1. In the collection, find Users → Create user.
  2. The request body has a placeholder JSON; the only fields you must set are external_id (any unique string), name, document_type (cpf or cnpj), and document_number. A safe sandbox CPF is 52998224725.
  3. Click Send.
  4. Expect a 201 response with the user's id. If you see 401 authentication_failed, the api_key variable wasn't picked up, re-check the environment selector.

From there, every other endpoint in the collection works the same way: tweak the body, click Send, observe.

Test_helpers for sandbox-only state driving

The collection includes the seven test_helpers endpoints under Test Helpers / Transactions (and one under Test Helpers / Users). Use them to drive a conversion lifecycle without waiting for real Pix or on-chain confirmations.

Staying in sync

The collection and environments are committed in BlendFi's API repo and refreshed periodically. Re-download from this page to get the latest set of endpoints. The OpenAPI Reference on this site (/docs/reference) is the canonical source for endpoint contracts. On any conflict between Postman and the Reference, the Reference wins.

Partner-only, internal collection is never published

BlendFi's internal Postman collection (used by ops + admin tooling) must not be exposed to the open internet. Three defense layers prevent accidental publication: the sync script (pnpm postman:sync) hardcodes the partner-only file list and refuses anything matching internal; a .gitignore rule blocks accidental git add of public/postman/*internal*; a CI workflow (partner-postman-guard.yml) fails any PR that ships an internal artifact under public/. Maintainers refreshing this collection should run pnpm postman:sync rather than copying files by hand.

On this page