Guides

Implementation guides

An end-to-end guide for each API Gateway module, with real flows, states, scopes, business errors, sandbox test data, webhooks and examples in all five SDKs and cURL.

Each guide covers a complete module: what it solves, the scopes your key needs, the business flow from start to finish, the typical engine errors, how to test it in the sandbox and which webhook events it emits. Every example is available in Python, JavaScript/TypeScript, PHP, .NET, Go and cURL; pick your language once and the site remembers it everywhere.

Which module does your entity integrate? #

If you are…Start withThen
A family compensation fund (caja de compensación) (like Caja Horizonte)AffiliatesSubsidies and monetary allowance, Credits, Loan portfolio, PQRS
A cooperative or employee fundCreditsLoan portfolio, PQRS
A fintech or wallet (like Nova)WalletWebhooks, PQRS
A healthcare provider (IPS) (like IPS Horizonte Salud)HealthWebhooks, PQRS
Any entity with its own ERPAdministrativeTransactions and system
flowchart LR
  subgraph Origination
    AF[Affiliates] --> CR[Credits]
    AF --> SU[Subsidies and<br/>monetary allowance]
  end
  CR -- disbursement --> CA[Loan portfolio]
  CR -- disbursement --> BI[Wallet]
  SU -- payment --> BI
  BI --> PQ[PQRS]
  CA --> PQ
  SA[Health] --> PQ
  AD[Administrative] -.accounting.- CA
  BI -.events.-> WH((Webhooks))
  CR -.events.-> WH
  CA -.events.-> WH
  SA -.events.-> WH

Before you start any guide #

  1. Get your sandbox key with the module’s scopes.
  2. Read Idempotency and Errors: every guide assumes you retry with the same Idempotency-Key and that you can tell engine rejections apart.
  3. If the module moves money or changes states asynchronously, set up your webhook receiver first.

To see every operation in a module with its exact parameters, go to the API reference. For flows that span several modules, see the recipes.

In this section #

Implementation guide AffiliatesCross-check and register your affiliate base with JSON batches or a CSV/Excel file, look up an affiliate by document and receive the affiliates.synced event. With … Implementation guide CreditsEnd-to-end credit origination: submit the application, work the queue, decide (APPROVE/REJECT), disburse, track the states and receive the credits.* events by webhook. … Implementation guide Subsidies and monetary allowanceSubmit statutory subsidies by type (e.g. unemployment), work the queue and decide; generate the period’s monetary allowance with dry_run, list it and disburse each … Implementation guide WalletOperate your affiliates’ wallet server-to-server: balance and transactions, P2P and Bre-B transfers, bill payments, mobile top-ups, pockets, cards and currency … Implementation guide Loan portfolioThe life of a disbursed loan through the API: an affiliate’s loans, installment schedule and breakdown by payment priority, payment history, collection recording … Implementation guide PQRSSubmit, look up, respond to and manage your affiliates’ PQRS (complaints and requests)—petitions, complaints, claims and suggestions—from your CRM or call center, … Implementation guide Health (IPS)For healthcare providers (IPS): catalog and availability; book, cancel, reschedule and record attendance on the patient’s behalf; health invoices with DIAN status, … Implementation guide Administrative (ERP)Integrate your ERP with Administrative Management: HR employees, contracts and HR adjustments, payroll adjustments and payslips, draft journal entries, third parties, … Implementation guide Transactions and systemCheck the asynchronous state of any write with client.transactions.get (status, history, reference) and validate the key and its scopes with client.system.health, which …