Skip to content

Suggested

API Dashboard

RecipesCreate a payment link

Create a payment link

Create a hosted checkout link when you do not want to build a payment UI from scratch.

Payment links are useful when you want to collect without building your own checkout UI. You define the amount, allowed payment methods, destination account, customer requirements, and redirect URLs. Conomy returns a checkout token that can be opened by the payer.

Note

Use payment links for invoices, manual collections, low-code checkout, or support-driven payment flows. Use direct POST /payments when your product owns the full payment UI.

01
Create link

Define items, methods, destination, and duration.

02
Share checkout

Send the hosted checkout URL to the customer.

03
Customer pays

The customer completes the hosted flow.

04
Reconcile

Use webhooks and payment reads as the source of truth.

Request
POST /sandbox/payment-links 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

{
  "checkoutToken": "invoice-1001",
  "currency": "CLP",
  "items": [
    {
      "preTaxAmount": "49990",
      "totalAmount": "49990",
      "description": "Invoice 1001"
    }
  ],
  "paymentMethodsAllowed": [
    "ETPAY",
    "WEBPAY"
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "49990",
      "currency": "CLP",
      "identity": {
        "identityId": "<MERCHANT_IDENTITY_ID>"
      },
      "account": {
        "accountNumber": "<MERCHANT_ACCOUNT_NUMBER>"
      }
    }
  ],
  "duration": 86400,
  "owner": {
    "identityId": "<MERCHANT_IDENTITY_ID>"
  },
  "customerRequirements": [
    "firstName",
    "email"
  ],
  "successUrl": "https://yourapp.com/invoices/1001/success",
  "failedUrl": "https://yourapp.com/invoices/1001/failed"
}
Response
{
  "id": "<PAYMENT_LINK_ID>",
  "checkoutToken": "invoice-1001",
  "status": "ACTIVE",
  "url": "https://checkout.conomyhq.com/invoice-1001"
}

Use this when your application needs a fresh checkout session from an existing payment link token.

Request
POST /sandbox/payment-links/token/{CHECKOUT_TOKEN}/checkout-sessions 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

{
  "customer": {
    "firstName": "Jane",
    "email": "jane@example.com"
  }
}
Response
{
  "id": "<CHECKOUT_SESSION_ID>",
  "checkoutToken": "invoice-1001",
  "status": "PENDING",
  "expiresAt": "2026-05-18T11:00:00Z"
}