POST /payment-links/token/{checkout-token}/checkout-sessions

Creates a checkout session from a payment-link checkout token.

POST/payment-links/token/{checkout-token}/checkout-sessions

Create checkout session from payment-link

Headers

Bearer access token returned by the authentication endpoint.

The API key used for authentication when making requests to the API Gateway.

API version selector for Conomy endpoints. Use 24-04-2025 for the current version.

Identifies the application making the request.

Path parameters

Checkout token that identifies the payment link session context.

Request body

Responses

idstringrequired

Unique identifier for the internal service.

paymentLinkIdstring

Reference Payment Link ID

checkoutTokenstring

Reference for checkout url

paymentConfigsobject[]required

createdAtstringdate-timerequired

When the link expires

statusstringrequired

ATTEMPTACTIVEEXPIREDFINISHEDPROCESSING_PAYMENTFAILED

itemsobject[]required

List of items to pay for

currencystringrequired

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

preTaxAmountstringrequired

Addition of all items preTaxAmounts

totalAmountstringrequired

Addition of all items totalAmounts

urlstringrequired

Url to open checkout flow

paymentMethodsAllowedstring[]min 1 itemsrequired

Allowed payment methods.

customerobjectnullable

Optional customer to pass into the checkout session

redirectUrlstring

The URL to which the end user will be redirected after completing the payment.

destinationsobject[]min 1 itemsrequired

A list of destinations for the transaction.

customerRequirementsstring[]

expiresAtstringdate-timerequired

ownerobjectrequired

Identity reference object used inside account nodes.

Request

POST /sandbox/payment-links/token/{checkout-token}/checkout-sessions HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {YOUR_API_KEY}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json

{}

const response = await fetch('https://api.conomyhq.com/sandbox/payment-links/token/{checkout-token}/checkout-sessions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

const data = await response.json();

import requests

payload = {}

response = requests.post(
    'https://api.conomyhq.com/sandbox/payment-links/token/{checkout-token}/checkout-sessions',
    headers={
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    },
    json=payload
)

data = response.json()

package main

import (
	"encoding/json"
	"net/http"
	"bytes"
)

func main() {
	payload, _ := json.Marshal(	{})
	body := bytes.NewBuffer(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/payment-links/token/{checkout-token}/checkout-sessions", body)
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()

	var data map[string]any
	json.NewDecoder(resp.Body).Decode(&data)
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let resp = client
        .post("https://api.conomyhq.com/sandbox/payment-links/token/{checkout-token}/checkout-sessions")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .header("Content-Type", "application/json")
        .json(&json!({}))
        .send()
        .await?;

    let data: serde_json::Value = resp.json().await?;
    Ok(())
}

Response

{
  "id": "string",
  "paymentLinkId": "string",
  "checkoutToken": "string",
  "paymentConfigs": [
    {
      "currency": "string",
      "product": "string",
      "exchangeRate": "string",
      "paymentMethods": [
        null
      ]
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "string",
      "totalAmount": "string",
      "description": "string"
    }
  ],
  "currency": "string",
  "preTaxAmount": "string",
  "totalAmount": "string"
}