Simulate payments

Simulates a payment to test the transaction process without real fund transfers.

Simulates a payment transaction by calculating exchange rates, fees, and total costs between specified origin and destination payment methods without storing any data in the database. This endpoint provides real-time estimates of the financial aspects of a potential payment, including currency conversion rates and applicable fees. It's ideal for presenting users with a cost preview before initiating an actual transaction.

POST/simulates

Authorization

x-api-keyBearer

Body

application/json

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.

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.

TOPUP_ACCOUNTWITHDRAWALTOPUP_CARDPAY_INPAY_OUTREWARDSREMITTANCESFEEON_RAMPOFF_RAMP

productproduct

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).

statustransactionStatus

ATTEMPTPENDINGPENDING_CAPTUREDCAPTUREDREFUNDEDINVESTEDFAILED

enrichenrich

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.

Response

200400404500

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

application/json

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.

TOPUP_ACCOUNTWITHDRAWALTOPUP_CARDPAY_INPAY_OUTREWARDSREMITTANCESFEEON_RAMPOFF_RAMP

productproduct

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).

statustransactionStatus

ATTEMPTPENDINGPENDING_CAPTUREDCAPTUREDREFUNDEDINVESTEDFAILED

enrichenrich

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.

Request

JavaScriptCurlPython

const response = await fetch('/simulates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "externalId": "text",
  "externalIdentityId": "text",
  "identityId": "text",
  "origins": [
    {
      "name": "text",
      "type": "text",
      "currency": "ARS",
      "referenceId": "text",
      "processing": "INSTANT_PAYMENT",
      "fee": {
        "name": "text",
        "type": "TRANSACTION",
        "method": "PERCENTAGE",
        "currency": "ARS",
        "value": "text"
      },
      "limits": {
        "minAmount": "text",
        "maxAmount": "text"
      },
      "metaData": {
        "image": "text",
        "title": "text",
        "description": "text"
      },
      "paymentInitiation": {
        "publicKey": "text",
        "widgetLink": "text",
        "signatureToken": "text",
        "origin": {
          "id": "text",
          "identity": "text",
          "externalId": "text",
          "accountNumber": "text",
          "nickName": "text",
          "country": "ARG",
          "currency": "ARS",
          "financialInstitution": "text",
          "type": "CASH_ACCOUNT",
          "accountHolder": "text",
          "accountHolderDni": "text",
          "balances": {
            "balance": "text",
            "availableFunds": "text",
            "accruedYield": "text",
            "monthlyYield": "text"
          },
          "createdAt": "text",
          "updatedAt": "text",
          "iban": "text",
          "sortCode": "text"
        }
      },
      "account": {
        "id": "text",
        "identity": "text",
        "externalId": "text",
        "accountNumber": "text",
        "nickName": "text",
        "country": "ARG",
        "currency": "ARS",
        "financialInstitution": "text",
        "type": "CASH_ACCOUNT",
        "accountHolder": "text",
        "accountHolderDni": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "iban": "text",
        "sortCode": "text"
      },
      "crypto": {
        "address": "text",
        "token": "USDC",
        "network": "ETHEREUM",
        "extendedData": [
          [
            {
              "name": "text",
              "value": "text"
            }
          ]
        ]
      }
    }
  ],
  "originAmount": {
    "amount": "text",
    "currency": "ARS"
  },
  "destinations": [
    {
      "name": "text",
      "type": "text",
      "currency": "ARS",
      "referenceId": "text",
      "processing": "INSTANT_PAYMENT",
      "fee": {
        "name": "text",
        "type": "TRANSACTION",
        "method": "PERCENTAGE",
        "currency": "ARS",
        "value": "text"
      },
      "limits": {
        "minAmount": "text",
        "maxAmount": "text"
      },
      "metaData": {
        "image": "text",
        "title": "text",
        "description": "text"
      },
      "paymentInitiation": {
        "publicKey": "text",
        "widgetLink": "text",
        "signatureToken": "text",
        "origin": {
          "id": "text",
          "identity": "text",
          "externalId": "text",
          "accountNumber": "text",
          "nickName": "text",
          "country": "ARG",
          "currency": "ARS",
          "financialInstitution": "text",
          "type": "CASH_ACCOUNT",
          "accountHolder": "text",
          "accountHolderDni": "text",
          "balances": {
            "balance": "text",
            "availableFunds": "text",
            "accruedYield": "text",
            "monthlyYield": "text"
          },
          "createdAt": "text",
          "updatedAt": "text",
          "iban": "text",
          "sortCode": "text"
        }
      },
      "account": {
        "id": "text",
        "identity": "text",
        "externalId": "text",
        "accountNumber": "text",
        "nickName": "text",
        "country": "ARG",
        "currency": "ARS",
        "financialInstitution": "text",
        "type": "CASH_ACCOUNT",
        "accountHolder": "text",
        "accountHolderDni": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "iban": "text",
        "sortCode": "text"
      },
      "crypto": {
        "address": "text",
        "token": "USDC",
        "network": "ETHEREUM",
        "extendedData": [
          [
            {
              "name": "text",
              "value": "text"
            }
          ]
        ]
      }
    }
  ],
  "destinationAmount": {
    "amount": "text",
    "currency": "ARS"
  },
  "type": "TOPUP_ACCOUNT",
  "product": "text",
  "status": "ATTEMPT",
  "enrich": {
    "merchantCode": "text",
    "merchantName": "text",
    "location": {
      "country": "ARG",
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "zipcode": "text",
      "optionalAddress": "text"
    }
  },
  "settlement": "INSTANT",
  "fees": [
    {
      "name": "text",
      "type": "TRANSACTION",
      "method": "PERCENTAGE",
      "currency": "ARS",
      "value": "text"
    }
  ],
  "exchange": {
    "id": "text",
    "type": "SPOT",
    "product": "text",
    "status": "CREATED",
    "origin": {
      "id": "text",
      "identity": "text",
      "externalId": "text",
      "accountNumber": "text",
      "nickName": "text",
      "country": "ARG",
      "currency": "ARS",
      "financialInstitution": "text",
      "type": "CASH_ACCOUNT",
      "accountHolder": "text",
      "accountHolderDni": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "iban": "text",
      "sortCode": "text"
    },
    "destination": {
      "id": "text",
      "externalId": "text",
      "address": "text",
      "token": "USDC",
      "network": "ETHEREUM",
      "type": "HOT",
      "multisigType": "TSS",
      "passphrase": "text",
      "status": "ACTIVE",
      "provider": "CONOMY",
      "keys": {
        "userKeychain": "text",
        "backupKeychain": "text",
        "providerKeychain": "text"
      },
      "extendedData": [
        [
          {
            "name": "text",
            "value": "text"
          }
        ]
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "exchangeRate": "text",
    "fee": "text",
    "executable": false,
    "provider": "text",
    "marketValue": "text",
    "extendedData": [
      {
        "name": "text",
        "value": "text"
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  },
  "metaData": {
    "description": "text",
    "image": "text",
    "category": "text"
  },
  "createdAt": "text",
  "updatedAt": "text",
  "expiredAt": "text"
}