API Reference / Checkout Sessions REST

Actions

When creating a transaction from a checkout session, this endpoint provides a payment method and a provider system to process the payment.

POST/checkout-sessions/{checkout_session_id}/payments

Create Payment from checkout session

Headers

Authorizationstringrequired

Bearer access token returned by the authentication endpoint.

x-api-keystringrequired

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

conomyhq-api-versionstring

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

User-Agentstringrequired

Identifies the application making the request.

Path parameters

checkout_session_idstringrequired

Unique identifier of the checkout session where the payment is submitted.

Request body

descriptionstring

A brief description of the transaction.

originsoneOf[]

A list of sources for the transaction.

namestring

The name of the source or destination of the transaction.

typestringrequired

CARDRepresents a card payment. Opens the card node.

CRYPTOCryptocurrency wallet rail (global). Supports both pay-in and pay-out flows. Opens the wallet node.

ACCOUNTRepresents an internal platform account. Opens the account node.

BANK_ACCOUNTGeneric external bank account for payouts. Opens the bank node.

PIXPIX QR code or copy-paste code in Brazil (BRL). Opens the pix node.

PCTInteroperable QR payment in Argentina (ARS) under BCRA PCT standard. Opens the pct node.

CVUVirtual account / CBU bank transfer pay-in in Argentina (ARS). Opens the cvu node.

ETPAYOpen banking pay-in for Chile (CLP) via Etpay. Opens the etpay node.

FINTOCOpen banking pay-in for Chile (CLP) via Fintoc widget. Opens the fintoc node.

WEBPAYCard payment in Chile (CLP) via Transbank. Opens the webpay node.

SPEIElectronic Interbank Payment System for Mexico (MXN). Opens the spei node.

PSEOnline secure bank transfer pay-in for Colombia (COP). Opens the pse node.

BANCOLOMBIABancolombia direct payment pay-in for Colombia (COP). Opens the bancolombia node.

DAVIVIENDADavivienda direct payment pay-in for Colombia (COP). Opens the davivienda node.

DAVIPLATADaviplata mobile wallet for Colombia (COP). Opens the daviplata node.

NEQUINequi digital wallet for Colombia (COP). Opens the nequi node.

BREBBank account transfer payout for Colombia (COP). Opens the breb node.

WOMPIWompi payment gateway pay-in for Colombia (COP). Opens the wompi node.

LIGOQR-based payment system pay-in for Peru (PEN). Opens the ligo node.

SIPInteroperable payment system for Peru (PEN) and Bolivia (BOB). Opens the sip node.

ACHAutomated Clearing House bank transfers for USA (USD). Opens the ach node.

WIREWire transfer via correspondent banks for USA (USD). Opens the wire node.

FEDNOWFedNow instant payment service for USA (USD). Opens the fedNow node.

RTPReal-time payments network pay-in for USA (USD). Opens the rtp node.

SEPASingle Euro Payments Area payout for Europe (EUR). Opens the sepa node.

FPEFaster Payments near-instant bank transfer payout for UK (GBP). Opens the fpe node.

SWIFTInternational bank wire transfer rail (global). Pay-out only. Opens the swift node.

externalIdstring

External reference identifier for integrations.

amountstring

The amount involved in the transaction.

amountOutstring

Calculated amount - fees

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.

settlementstring

Indicates the settlement period.

feeobjectshow 5 properties

Details about any fees applied to the transaction.

identityobjectshow 4 properties

The entity associated with the source or destination.

metadataobjectshow 3 properties

Additional metadata related to the transaction source or destination.

One of

CARDACCOUNTBANK_ACCOUNTCRYPTOPIXPCTETPAYFINTOCWEBPAYWOMPIPSEBANCOLOMBIADAVIVIENDADAVIPLATANEQUIBREBCVUSPEILIGOSIPACHWIREFEDNOWRTPSEPAFPESWIFT

cardobjectrequiredshow 6 properties

accountobjectrequiredshow 4 properties

bankobjectrequiredshow 7 properties

walletobjectrequiredshow 5 properties

pixobjectrequiredshow 7 properties

PIX rail payload for Brazil pay-ins and payouts.

pctobjectrequiredshow 4 properties

PCT rail payload for Argentina QR pay-ins.

etpayobjectrequiredshow 8 properties

Etpay open-banking payload for Chile pay-ins.

fintocobjectrequiredshow 3 properties

webpayobjectrequiredshow 3 properties

wompiobjectshow 6 properties

Wompi gateway payload for Colombia pay-ins.

pseobjectrequiredshow 4 properties

bancolombiaobjectrequiredshow 3 properties

daviviendaobjectrequiredshow 3 properties

daviplataobjectrequiredshow 3 properties

nequiobjectrequiredshow 3 properties

brebobjectrequiredshow 4 properties

cvuobjectrequiredshow 2 properties

speiobjectrequiredshow 2 properties

ligoobjectrequiredshow 3 properties

sipobjectrequiredshow 3 properties

achobjectrequiredshow 4 properties

wireobjectrequiredshow 5 properties

fedNowobjectrequiredshow 4 properties

rtpobjectrequiredshow 4 properties

sepaobjectrequiredshow 3 properties

fpeobjectrequiredshow 3 properties

swiftobjectrequiredshow 4 properties

Responses

200Request processed successfully.

idstringrequired

Unique identifier for the internal service.

externalIdstringrequired

External reference identifier for integrations.

identityIdstringrequired

Identifier linking the transaction to a specific user or organization.

identityExternalIdstring

External reference identifier for the identity associated with the transaction.

accountNumberstringrequired

The account number involved in the transaction.

totalAmountstringrequired

The total amount of the transaction.

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.

descriptionstring

A brief description of the transaction.

productstring

The product or service related to the transaction. purchaseCurrency:Currency

statusstringrequired

The current status of the transaction (e.g., PENDING, AUTHORIZED, CAPTURED, ATTEMPT, REFUNDED).

typestringrequired

PURCHASEPayment initiated by an external customer for goods or services.

TOPUP_ACCOUNTA deposit of funds into an internal account

WITHDRAWAL_ACCOUNTFunds withdrawn from an internal account to an external bank account.

P2PPull of funds from another internal account.

COLLECTPull of funds from another internal account.

FEEFee charged or collected within the system.

REMITTANCECrossborder payment from an internal or external account to receipient in another country.

purchaseAmountstring

The amount paid in the transaction.

purchaseCurrencystring

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.

feesobject[]show items

A list of fees associated with the transaction.

createdAtstringrequired

Timestamp indicating when the transaction was created.

updatedAtstringrequired

Timestamp indicating the last update to the transaction.

expiresAtstring

Timestamp indicating when the transaction expires, if applicable.

capturedAtstring

Timestamp indicating when the transaction was captured.

authorizedAtstring

Timestamp indicating when the transaction was authorized.

refundedAtstring

Timestamp indicating when the transaction was refunded, if applicable.

originsoneOf[]show items

A list of sources for the transaction.

destinationsoneOf[]show items

A list of destinations for the transaction.

settlementstring

Settlement period for the transaction.

400Invalid request parameters or payload.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

500Unexpected internal server error.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

Request

HTTPcurlTypeScriptPythonGoRust

POST /sandbox/checkout-sessions/{checkout_session_id}/payments 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

{
  "origins": [
    {
      "name": "ETPAY",
      "type": "PAYMENT_INITATION",
      "amount": "100",
      "currency": "ARS",
      "paymentInitiation": {
        "origin": "ETPAY",
        "referenceId": "external_payment_id_1"
      }
    }
  ]
}

curl -X POST \
  'https://api.conomyhq.com/sandbox/checkout-sessions/{checkout_session_id}/payments' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {YOUR_API_KEY}' \
  -H 'conomyhq-api-version: 24-04-2025' \
  -H 'User-Agent: MyApp/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "origins": [
      {
        "name": "ETPAY",
        "type": "PAYMENT_INITATION",
        "amount": "100",
        "currency": "ARS",
        "paymentInitiation": {
          "origin": "ETPAY",
          "referenceId": "external_payment_id_1"
        }
      }
    ]
  }'

const response = await fetch('https://api.conomyhq.com/sandbox/checkout-sessions/{checkout_session_id}/payments', {
  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({
    "origins": [
      {
        "name": "ETPAY",
        "type": "PAYMENT_INITATION",
        "amount": "100",
        "currency": "ARS",
        "paymentInitiation": {
          "origin": "ETPAY",
          "referenceId": "external_payment_id_1"
        }
      }
    ]
  }),
});

const data = await response.json();

import requests

payload = {
    "origins": [
        {
            "name": "ETPAY",
            "type": "PAYMENT_INITATION",
            "amount": "100",
            "currency": "ARS",
            "paymentInitiation": {
                "origin": "ETPAY",
                "referenceId": "external_payment_id_1"
            }
        }
    ]
}

response = requests.post(
    'https://api.conomyhq.com/sandbox/checkout-sessions/{checkout_session_id}/payments',
    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(	{
	  "origins": [
	    {
	      "name": "ETPAY",
	      "type": "PAYMENT_INITATION",
	      "amount": "100",
	      "currency": "ARS",
	      "paymentInitiation": {
	        "origin": "ETPAY",
	        "referenceId": "external_payment_id_1"
	      }
	    }
	  ]
	})
	body := bytes.NewBuffer(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/checkout-sessions/{checkout_session_id}/payments", 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/checkout-sessions/{checkout_session_id}/payments")
        .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!({
        "origins": [
                {
                        "name": "ETPAY",
                        "type": "PAYMENT_INITATION",
                        "amount": "100",
                        "currency": "ARS",
                        "paymentInitiation": {
                                "origin": "ETPAY",
                                "referenceId": "external_payment_id_1"
                        }
                }
        ]
}))
        .send()
        .await?;

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

Response

200 400 401 403 404 422 500

{
  "id": "string",
  "externalId": "string",
  "identityId": "string",
  "identityExternalId": "string",
  "accountNumber": "string",
  "totalAmount": "string",
  "currency": "string",
  "description": "string",
  "product": "string",
  "status": "string"
}

{
  "error": {
    "type": "bad_request",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "unauthorized",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "forbidden",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "not_found",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "validation_error",
    "info": {
      "field": "string",
      "message": "string"
    }
  },
  "message": null
}

{
  "error": {
    "type": "internal_error",
    "info": null
  },
  "message": null
}