POST /payment-links/{id}/activate

Activates a payment link so it can accept new checkout sessions.

POST/payment-links/{id}/activate

Activate 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

Unique identifier of the payment link to activate.

Responses

idstringrequired

Unique identifier for the internal service.

checkoutTokenstringrequired

Reference for checkout url

statusstringrequired

ATTEMPTACTIVEEXPIREDFINISHEDPROCESSING_PAYMENT

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

createdAtstringdate-timerequired

When the link expires

destinationsobject[]min 1 itemsrequired

A list of destinations for the transaction.

durationinteger≥ 30required

Amount of seconds for payment link to be inactivated after creation

customerRequirementsstring[]

ownerobjectrequired

Identity reference object used inside account nodes.

successUrlstring

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

failedUrlstring

The URL to which the end user will be redirected after failed payment or cancellation.

Request

POST /sandbox/payment-links/{id}/activate 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

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/payment-links/{id}/activate", nil)
	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")

	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/{id}/activate")
        .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")
        .send()
        .await?;

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

Response

{
  "id": "string",
  "checkoutToken": "string",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "string",
      "totalAmount": "string",
      "description": "string"
    }
  ],
  "currency": "string",
  "preTaxAmount": "string",
  "totalAmount": "string",
  "url": "string",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {}
}