Documentation to integrate the platform and build your local adaptation.

Integra’s documentation is organized for two different jobs: integrating the PSP’s and its customers’ systems with the APIs, and building the adapters that connect the platform to the market’s rails. Access is enabled for teams evaluating or integrating.

Documentation

Entry point: concepts, data model, states and glossary. How customers, accounts, operations and transactions relate.

  • Data model and states
  • Identifiers and references
  • Errors and codes

API Reference

Reference per module: routes, fields, filters, pagination and request/response examples.

  • Customers and users
  • Accounts and movements
  • Operations and transactions
  • Files, reconciliation and reporting

Authentication

Scoped keys per environment, rotation, required headers and idempotency.

  • Scopes and permissions
  • Idempotency-Key
  • Key rotation

Webhooks

Event catalogue, format, signing and verification, retries, resend and consumption best practices.

  • Event catalogue
  • Signature verification with examples
  • Retries and resend

Integration Guides

Guides per flow (payout, collection, transfer, file, reconciliation) and the local adaptation guide: how to implement a rail adapter on the framework contracts.

  • End-to-end business flows
  • Local adaptation guide
  • Adapter contracts

Environments

Test and production environments: routes, credentials, sample data and behaviour differences.

  • Credentials per environment
  • Sample data
  • Promotion to production

Testing

How to test integrations and adapters: scenarios, rail result simulation, event verification and certification.

  • Test scenarios
  • Result simulation
  • Adapter certification

Request access

Leave us your company details and technical contact. We enable access to the documentation and the test environment for teams evaluating or integrating.

Request access
Create a payment operationIllustrative · request
POST /v1/operations
Authorization: Bearer sk_test_••••••••
Idempotency-Key: cust-7781-payroll-2026-09

{
  "customer_id": "cus_01J9K2",
  "type": "payout",
  "currency": "COP",
  "items": [
    { "beneficiary": { "id_type": "CC", "id": "1020304050" },
      "destination": { "rail": "psp-local:bank-transfer", "account": "4581••••••" },
      "amount": 1850000, "reference": "Servicios septiembre" }
  ],
  "workflow": "two-step-approval"
}
Event: transaction confirmedIllustrative · event
POST https://psp.example/webhooks/integra
X-Integra-Signature: t=1758037331,v1=6d1f…

{
  "id": "evt_01J9K5",
  "type": "transaction.confirmed",
  "data": {
    "transaction_id": "txn_01J9K4",
    "operation_id": "op_01J9K3Q8X2",
    "rail": "psp-local:bank-transfer",
    "rail_reference": "…",
    "amount": 1850000, "currency": "COP"
  }
}
Integration point: rail adapter contractIllustrative · conceptual
// Lo que el PSP implementa para conectar un riel de su mercado.
// Conceptual: nombres y firmas se entregan en la documentación.
interface RailAdapter {
  readonly id: "psp-local:bank-transfer";
  submit(tx: TransactionInstruction): Promise<Acknowledgement>;
  status(ref: RailReference): Promise<RailState>;
  importStatement(file: Statement): Promise<StatementLines>;
}

// Integra llama a submit() cuando la operación queda aprobada
// y actualiza la transacción con lo que el adaptador reporta.

The snippets on this page are illustrative. The binding technical reference is the documentation delivered with access.

Request access

Leave us your company details and technical contact. We enable access to the documentation and the test environment for teams evaluating or integrating.

Build and operate your PSP on Integra.

Tell us what you operate today and which rails you need to connect. We will show you the platform on your case.