API Reference / Origins & Destinations REST

Actions

Returns available pay-in node configurations for the requested product and currency pair.

GET/payment-origins

Get payment-origins

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.

Query parameters

accountNumberstring

corresponding accountNumber

currencystring

Target settlement currency used to resolve available origins (ISO 4217).

purchaseCurrencystring

Source purchase currency used to resolve available origins (ISO 4217).

Responses

200Request processed successfully.

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 for Argentina (ARS). Supports pay-in (static or dynamic CVU allocation) and pay-out (provide recipient CVU code). 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.

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.

productstring

Product identifier for the payment rail, in the format CURRENCY:CURRENCY (e.g., ARS:ARS, USD:COP).

settlementstring

Indicates the settlement period.

feeobjectshow 5 properties

Details about any fees applied to the transaction.

metadataobjectshow 3 properties

Additional metadata related to the transaction source or destination.

minAmountstring/^\d+$/

Minimum transaction amount allowed for this node.

maxAmountstring/^\d+$/

Maximum transaction amount allowed for this node.

requiredFieldsstring[]

Dot-notation paths of fields required when using this node (e.g., bank.accountNumber, pct.customer.email).

validOriginsstring[]

Node types that are valid as origins when this node is used as a destination.

validDestinationsstring[]

Node types that are valid as destinations when this node is used as an origin.

nodeSchemaobject

Dynamic schema describing the structure of the node-specific object. Each key matches the node key (e.g., bank, pct, cvu) and its value reflects the expected field structure.

requiredFieldTypesobject

Map of dot-notation field paths to their expected types (e.g., { "bank.accountNumber": "string" }).

One of

CARDACCOUNTBANK_ACCOUNTCRYPTOPIXPCTETPAYFINTOCWEBPAYWOMPIPSEBANCOLOMBIADAVIVIENDADAVIPLATANEQUIBREBCVUSPEILIGOSIPACHWIREFEDNOWRTPSEPAFPESWIFT

cardobjectrequired− hide properties

holderstring

Card holder full name

schemestring

Card scheme

typestring

Card type

maskstring

Last 4 digits

countrystring

Issuing country

tokenstringrequired

Card token

accountobjectrequired− hide properties

identityIdstringrequired

Identifier linking the internal account to an organization or user.

typestringrequired

CHECKINGFiat liquid account used for spending, withdrawals, or operations.

ASSETTracks non-operational or financial assets.

SAVINGSHolds funds intended for savings or long-term storage.

ESCROWTemporary routing account for incoming funds.

FEEHolds all fees collected via FEE or FEE_INVOICE.

balancestring/^\d+(\.\d+)?$/required

Total balance available in the internal account.

availableFundsstring/^\d+(\.\d+)?$/required

Amount of funds available for transactions.

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.

namestringrequired

A friendly name assigned to the internal account.

accountNumberstringrequired

Internal reference number for the account.

accountHolderstringrequired

Name of the entity or user owning the internal account.

bankobjectrequired− hide properties

accountNumberstringrequired

The bank account number.

bankstringrequired

The name of the bank where the account is held.

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.

typeAccountstring

Type of bank account. Accepted values: CHECKING, SAVINGS.

accountHolderstringrequired

The full name of the account holder.

accountHolderDnistringrequired

The national identification number or tax ID of the account holder.

countrystringrequired

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

walletobjectrequired− hide properties

providerstring

Optional wallet provider identifier (for routing/integration).

referenceIdstring

Optional external wallet identifier in the provider system.

tokenstring

Optional token symbol (e.g., USDC, USDT) when not implied by currency.

networkstring

Optional blockchain network (e.g., ETH, TRON, SOLANA).

addressstringrequired

Wallet's address

pixobjectrequired− hide properties

minimumAmountstring/^\d+$/

Minimum amount allowed.

maximumAmountstring/^\d+$/

Minimum amount allowed.

pctobjectrequired− hide properties

qrCodestring

QR code string to be rendered or scanned for payment.

customerobjectshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

etpayobjectrequired− hide properties

customerobjectshow 9 properties

Information on who pays the transaction

urlstring

tokenstring

signatureTokenstring

fintocobjectrequired− hide properties

customerobjectshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

webpayobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

wompiobjectshow 6 properties

Wompi gateway payload for Colombia pay-ins.

pseobjectrequired− hide properties

bankIdstringrequired

Bank identifier for PSE transfer.

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

bancolombiaobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

daviviendaobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

daviplataobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

nequiobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

brebobjectrequired− hide properties

bankIdstringrequired

Bank identifier for the recipient's account.

accountNumberstringrequired

Recipient's bank account number.

accountTypestring

CHECKINGSAVINGS

customerobjectrequiredshow 9 properties

Information on who pays the transaction

cvuobjectrequired− hide properties

codestring

The CVU code for this node. Required when CVU is used as a destination (pay-out) — provide the recipient's CVU number. For pay-in in dynamic mode, omit this field — the platform allocates a unique code per payment attempt and returns it here in the response. In static pay-in mode, this field carries the fixed CVU pre-assigned to the identity; retrieve it with GET /payment-origins and send it in the CVU origin when creating the static CVU payment.

customerobjectshow 9 properties

Information on who pays the transaction

speiobjectrequired− hide properties

clabestringrequired

CLABE (18-digit interbank code) of the recipient. Required for pay-out.

customerobjectrequiredshow 9 properties

Information on who pays the transaction

ligoobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

sipobjectrequired− hide properties

customerobjectrequiredshow 9 properties

Information on who pays the transaction

successUrlstring

Redirect URL on successful payment.

failedUrlstring

Redirect URL on failed payment.

achobjectrequired− hide properties

routingNumberstringrequired

ABA routing number (9 digits).

accountNumberstringrequired

Bank account number.

accountTypestring

CHECKINGSAVINGS

customerobjectrequiredshow 9 properties

Information on who pays the transaction

wireobjectrequired− hide properties

swiftCodestringrequired

SWIFT/BIC code of the recipient's bank.

routingNumberstring

ABA routing number (9 digits).

accountNumberstringrequired

Recipient's bank account number.

bankNamestring

Name of the recipient's bank.

customerobjectrequiredshow 9 properties

Information on who pays the transaction

fedNowobjectrequired− hide properties

routingNumberstringrequired

ABA routing number (9 digits).

accountNumberstringrequired

Bank account number.

accountTypestring

CHECKINGSAVINGS

customerobjectrequiredshow 9 properties

Information on who pays the transaction

rtpobjectrequired− hide properties

routingNumberstringrequired

ABA routing number (9 digits).

accountNumberstringrequired

Bank account number.

accountTypestring

CHECKINGSAVINGS

customerobjectrequiredshow 9 properties

Information on who pays the transaction

sepaobjectrequired− hide properties

ibanstringrequired

Recipient's IBAN.

bicstring

BIC/SWIFT code of the recipient's bank.

customerobjectrequiredshow 9 properties

Information on who pays the transaction

fpeobjectrequired− hide properties

accountNumberstringrequired

UK bank account number (8 digits).

sortCodestringrequired

Sort code (6 digits, e.g., "200415").

customerobjectrequiredshow 9 properties

Information on who pays the transaction

swiftobjectrequired− hide properties

swiftCodestringrequired

SWIFT/BIC code of the recipient's bank.

ibanstring

Recipient IBAN when destination country requires it (typically SEPA zone).

bankobjectrequiredshow 2 properties

Recipient bank account details.

customerobjectrequiredshow 9 properties

Beneficiary identity data required by correspondent banks.

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.

CodeTry it Workbench

Request

HTTPcurlTypeScriptPythonGoRust

GET /sandbox/payment-origins 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

curl -X GET \
  'https://api.conomyhq.com/sandbox/payment-origins' \
  -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'

const response = await fetch('https://api.conomyhq.com/sandbox/payment-origins', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
  },
});

const data = await response.json();

import requests

response = requests.get(
    'https://api.conomyhq.com/sandbox/payment-origins',
    headers={
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    }
)

data = response.json()

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.conomyhq.com/sandbox/payment-origins", 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
        .get("https://api.conomyhq.com/sandbox/payment-origins")
        .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

200 400 401 403 404 422 500

[
  {
    "card": {
      "token": "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
}

Requestsandbox

Authentication

Bearer token*

Headers

x-api-key*

User-Agent*

Query parameters

accountNumber

currency

purchaseCurrency

Send →