Skip to content

Suggested

API Dashboard

FundamentalsHow Conomy works

How Conomy works

The operational model behind Conomy: authenticate, model actors, discover rails, create payments, capture, and reconcile.

Conomy is a server-to-server payments platform. Your backend owns the integration, creates the resources, builds payment requests, and reconciles the final state from API reads and webhooks.

01
Authenticate

Exchange credentials for a bearer token and send the same headers on protected requests.

02
Model actors

Create identities and accounts for the organization, users, merchants, or operating balances.

03
Discover rails

Call available-products to know which origins, destinations, currencies, and fields are valid.

04
Create payment

Send one or more origin nodes and one or more destination nodes in POST /payments.

05
Reconcile

Capture when required, listen to webhooks, and confirm the final state with GET /payments/{id}.

Note

Do not hardcode rails. Always build the payment form from GET /payments/available-products so the UI matches the identity, country, currency, and enabled providers.

An identity is the actor. An account is the internal balance. A payment moves value between origins and destinations. A rail such as CARD, PIX, ETPAY, BANK_ACCOUNT, or SPEI is represented as a node inside the payment.

  1. Use Authentication to obtain the bearer token.
  2. Create the identities and accounts needed by your product.
  3. Use Transaction builder to generate the first valid request shape.
  4. Follow Recipes to run the first sandbox top-up or withdrawal.
  5. Use API Reference only when you need exact parameters, objects, and response schemas.