Adds origins to a payment transaction by transactionId, providing details like bank accounts or cards associated with the payment source.
Adds origins to an existing payment transaction identified by transactionId. The payment entity is used to provide detailed information about the origins.
Unique identifier assigned to each payment transaction within the system. It is used to reference and track transactions across all API operations, such as creating, confirming, and querying payments.
Body
namestring
Unique identifier of the payment method.
typestring
The origin and destination fields define the source and destination of funds in a transaction. Each supports specific payment types:
origin the source of funds, which can be one of the following:
PAYMENT_INITIATION: A third-party service for initiating payments directly from a bank account.
WIRE: A traditional wire transfer from a bank account.
CARD: Payments made via credit or debit cards.
CRYPTO: Payments made using cryptocurrency, with funds originating from a digital wallet.
CASH: Payments made via cash.
destination the destination of funds, which supports the following:
WIRE: A traditional wire transfer to a bank account.
CRYPTO: Payments sent to a cryptocurrency wallet on a blockchain network.
CASH: Payments withdrawn via cash.
currencycurrencySymbol
Currency code supported by the payment method. For cryptocurrencies, include both the token and network (e.g., USDC_SOLANA). For fiat currencies, use the standard ISO 4217 currency codes.
Fees represent additional charges applied to a transaction. These can be applied over the transaction, origins, destinations, or FX (foreign exchange), and are either calculated as a percentage of the amount or as a fixed amount.
limitsobject
Transaction limits
metaDataobject
Human readable information
paymentInitiationPayment Initiation
Represents a payment initiation, detailing the widget information, and origin of funds.
accountaccount
Details about a user's bank account, including the account number, bank, holder information, and associated metadata.
cryptowalletInformation
Represents a crypto wallet, detailing the address, network, and related information for executing cryptocurrency transactions.
Response
Represents the comprehensive transaction entity encompassing the entire payment process. It includes details from the initial payment attempt through to the final payment confirmation. It is the primary reference for tracking and managing the lifecycle of a payment within the system.
Body
idid
A unique identifier, represented as a UUID (Universally Unique Identifier).
externalIdstring
An external reference ID for the transaction, used for integrations with external systems.
externalIdentityIdstring
External user reference ID, linking the transaction to the external system's user.
identityIdstring
Internal identity identifier within the ConomyHQ system. It uniquely identifies the user associated with the transaction.
originsarray of payment
originAmountobject
The amount and currency of the transaction before applying any fees or exchanges.
destinationsarray of payment
destinationAmountobject
The amount and currency after applying fees and exchanges. This represents the total amount paid or withdrawn.
typetransactionType
Represents the various types of financial transactions, ranging from card payments to remittances, savings-related transactions, and more.
The currency pair being traded, formatted as CURRENCY 1:CURRENCY 2, where the first currency is the base currency and the second is the counter currency. This defines what is being exchanged (e.g., CLP:USD or CLP:USDC_SOLANA).
The enrich object provides details about the merchant receiving the payment, including their code, name, and location.
settlementenum
Specifies how often settlements occur for this transaction, such as 'INSTANT', 'DAILY', 'WEEKLY', or 'MONTHLY'.
INSTANTDAILYWEEKLYMONTHLY
feesarray of feeInfo
An array of fees applied to the transaction. Each fee entry describes the type and amount of the fee.
exchangequote
The quote entity represents a specific exchange quote provided by a provider, including details such as the user, transaction, exchange rate, and status.
metaDataobject
createdAtcreatedAt
Creation date, in ISO 8601 date format
updatedAtupdatedAt
Date of last update, in ISO 8601 date format
expiredAtstring
The expiration date of the transaction, in ISO 8601 date format.