Recipes

Follow the shortest path from credentials to a reconciled payment.

Recipes are implementation guides. Each one should leave you with a concrete ID, request, response, or production check that unlocks the next step.

Payment quickstart

Generate the request before wiring every endpoint.

Pick the intent, currencies, origin rail, and destination account. The builder returns the exact shape your backend sends to Conomy.

Open builder View endpoint

      
          POST /sandbox/payments HTTP/1.1
        
          Host: api.conomyhq.com
        
          x-api-key: {YOUR_API_KEY}
        
          Authorization: Bearer {ACCESS_TOKEN}
        
          conomyhq-api-version: 24-04-2025
        
          User-Agent: MyApp/1.0
        
          Content-Type: application/json
        
          Accept: application/json
        
           
        
          {
        
            "type": "TOPUP_ACCOUNT",
        
            "product": "CLP:CLP",
        
            "origins": [{ "type": "ETPAY" }],
        
            "destinations": [{ "type": "ACCOUNT" }]
        
          }
        
    

Authenticate Create resources Build payment Capture Reconcile

Setup

Create the operating context

Authenticate, create the organization identity, add users, and open internal accounts before moving money.

01 Obtain an access token Exchange client credentials for the bearer token used by protected endpoints. 02 Create an organization Create the identity that owns accounts, users, and payment activity. 03 Create users Add user identities when your flow has operators, sellers, or service providers. 04 Create accounts Open the internal balances that payments fund or draw from.

Build payment UI

Render only what the identity can use

Discover enabled currencies, rails, required fields, and request shape before presenting a payment form.

01 Render payment methods Use available products to build a dynamic payment method picker. 02 Prevalidate a payment Create an attempt before committing the final payment. 03 Generate a payment request Pick the intent, currencies, rail nodes, and copy the generated request.

Money movement

Run the common payment jobs

Each recipe maps a business job to the exact origin, destination, capture, and reconciliation steps.

Pay in Create your first top-up Fund an internal account from an external pay-in rail. Pay out Create your first withdrawal Move balance from an internal account to a payout destination. Sale Create a purchase Charge a customer and settle value into a merchant account. Cross-border Create a remittance Pay out to a recipient across currency or country boundaries. P2P Transfer between accounts Move funds between two internal Conomy accounts. Pool Collect from accounts Gather multiple internal origins into one account. Link Create a payment link Collect without building a checkout UI from scratch. Checkout Create a checkout session Open a short-lived payer session from a link or token.

Reconciliation

Close the loop after creation

Capture payments, mirror final state, handle review gates, and make webhook processing idempotent.

State Capture and reconcile Advance a payment and confirm its final state from the API. Events Handle payment webhooks Confirm final payment state without polling every transaction. Review Handle payment review Attach required documents when a transaction enters compliance review. Refunds Track refunds Reconcile refund children against the original settled payment.

Production

Prepare to launch

Validate credentials, webhooks, error handling, retries, limits, and operational ownership before real traffic.

Launch Going live Confirm the production checklist and expected support data.