Partial update of payment

Partially updates specific fields like metadata of a payment by transactionId using PATCH, allowing incremental changes without replacing the entire resource.

Partially updates specific fields like metadata of an existing payment transaction identified by transactionId. Using HTTP PATCH semantics, this endpoint allows for modifying certain attributes without replacing the entire transaction resource. It's helpful for making incremental changes as the payment progresses through different stages.

patch

Authorizations

x-api-keyBearer

Path parameters

transactionIdstringrequired

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

idstringoptional

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.

externalIdstringoptional

An external reference ID for the transaction, used for integrations with external systems.

externalIdentityIdstringoptional

External user reference ID, linking the transaction to the external system's user.

identityIdstringoptional

Internal identity identifier within the ConomyHQ system. It uniquely identifies the user associated with the transaction.

originsobject[]optional

payment schema

originAmountobjectoptional

The amount and currency of the transaction before applying any fees or exchanges.

destinationsobject[]optional

payment schema

destinationAmountobjectoptional

The amount and currency after applying fees and exchanges. This represents the total amount paid or withdrawn.

typestring · enumoptional

Represents the various types of financial transactions, ranging from card payments to remittances, savings-related transactions, and more.

Available options:

productstringoptional

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

statusstring · enumoptional

Available options:

enrichobjectoptional

The enrich object provides details about the merchant receiving the payment, including their code, name, and location.

settlementstring · enumoptional

Specifies how often settlements occur for this transaction, such as 'INSTANT', 'DAILY', 'WEEKLY', or 'MONTHLY'.

Available options:

feesobject[]optional

An array of fees applied to the transaction. Each fee entry describes the type and amount of the fee.

exchangeobjectoptional

An array of exchanges applied to the transaction, including currency conversions or asset exchanges.

metaDataobjectoptional

createdAtstringoptional

Creation date, in ISO 8601 date format

updatedAtstringoptional

Date of last update, in ISO 8601 date format

expiredAtstringoptional

The expiration date of the transaction, in ISO 8601 date format.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/payments/{transactionId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": true,
      "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"
  }'

200

400

404

500

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": true,
    "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"
}

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.