Every payment defines its flow of funds through origins (where the money comes from) and destinations (where the money goes). Each entry is a payment-node: a type plus a sub-object that carries the configuration for that rail.
Only one node sub-object should be present per payment-node, matching the selected type.
| Field | Description |
|---|
name | Provider executing or receiving the payment. Defaults to conomy_hq. |
type | Defines the rail. Drives which sub-object is required. |
amount | Per-node amount. Required only when splitting funds across multiple nodes. |
currency | ISO currency code. See Currencies. |
identity | Identity associated with the node — typically the account owner. |
{node} | Rail-specific sub-object. Its key matches the type in camelCase (e.g. "type": "PIX" → "pix": {...}). |
Rails are grouped by country. Each rail page documents required fields, optional fields, an example, and valid destinations.
| Type | Description |
|---|
ACCOUNT | Internal conomy_hq account. Used as origin or destination on internal flows. |
BANK_ACCOUNT | External bank account. Used as a destination when no country-specific rail applies. |
| Type | Description | Direction |
|---|
CVU | Bank transfer via the CVU rail | Pay-in |
PCT | QR transfer | Pay-in |
| Type | Description | Direction |
|---|
PIX | Instant payment | Pay-in / Pay-out |
| Type | Description | Direction |
|---|
ETPAY | Open banking | Pay-in |
FINTOC | Open banking via Fintoc | Pay-in |
WEBPAY | Card payments via Transbank | Pay-in |
| Type | Description | Direction |
|---|
SPEI | CLABE transfer | Pay-in / Pay-out |
| Type | Description | Direction |
|---|
ACH | Bank transfer | Pay-in / Pay-out |
FEDNOW | Instant bank | Pay-in / Pay-out |
RTP | Real-time payments | Pay-in |
WIRE | Wire transfer | Pay-out |
| Type | Description | Direction |
|---|
PAGO_MOVIL | Mobile bank transfer | Pay-in |
| Type | Description | Direction |
|---|
SEPA | IBAN transfer | Pay-out |
FPE | UK Faster Payments | Pay-out |
| Type | Description | Direction |
|---|
SWIFT | International wire transfer | Pay-out |
| Type | Description | Direction |
|---|
CRYPTO | Crypto wallet | Pay-in / Pay-out |
| Payment type | Valid origins | Valid destinations |
|---|
TOPUP_ACCOUNT | Any pay-in rail | ACCOUNT |
WITHDRAWAL_ACCOUNT | ACCOUNT | Any pay-out rail |
PURCHASE | Any pay-in rail | ACCOUNT |
REMITTANCE | ACCOUNT or any pay-in rail | Any pay-out rail |
P2P | ACCOUNT | ACCOUNT |
COLLECT | ACCOUNT | ACCOUNT |
- If a payment has a single origin and a single destination,
amount per node is optional — it defaults to the payment’s purchaseAmount.
- If a payment has multiple origins or destinations, every node must carry an
amount and the sums must equal purchaseAmount.
- Only the sub-object matching
type is allowed on a node. Send "type": "PIX" together with "pix": {...} and nothing else.
