conomy_hq
  • home
    • 👋 Welcome to conomy_hq
    • Countries
    • Currencies
    • Financial institutions
  • Accounts
    • Overview
    • Account types
  • Payments
    • Overview
    • Quickstart
    • Transaction types
  • Whitelabel
    • Overview
  • API reference
    • Introduction
    • Auth
      • Authenticate
    • Identities
      • Create an identity
      • Retrieve an identity
    • Currencies
      • Retrieve available currencies
      • Retrieve currency
    • Financial institution
      • Retrieve financial institutions
    • Payment methods
      • Retrieve payment origins
      • Retrieve payment destinations
    • Transactions
      • Simulate payments
      • Payment attempts
        • Payment methods
          • Add origin
          • Add destination
          • Delete origin
          • Delete destination
        • Create payment attempt
        • Retrieve payment attempt
        • Update of payment attempt
        • Partial update of payment attempt
        • Delete payment attempt
      • Payments
        • Create payment
        • Retrieve payment
        • Partial update of payment
        • Confirm payment
        • Cancelation of payment
    • Models
      • Financial institutions
        • Financial institution
      • Identities
        • Identity
        • Bank account
        • Company
        • User [WIP ⚙️]
      • Currencies
        • Currency
      • Payment methods
        • Payment
        • Payment Initiation
        • Account
        • Crypto
      • Fees
        • Fee
        • Fee information
      • Transaction
        • Transaction
        • Quote
        • Enrich
Powered by GitBook
  1. API reference
  2. Transactions
  3. Payments

Cancelation of payment

Cancels a payment by transactionId before confirmation, updating its status to 'cancelled' and preventing further processing or completion.

PreviousConfirm paymentNextModels

Last updated 5 months ago

Cancels an existing payment transaction identified by transactionId, provided it has not been confirmed yet. This operation updates the transaction status to 'cancelled', preventing any further processing. It's useful for aborting payments that are no longer valid, desired, or were initiated by mistake. Once cancelled, the payment cannot be confirmed or completed.

delete
Authorizations
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.

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/payments/{transactionId}' \
  --header 'x-api-key: YOUR_API_KEY'
204
400
404
500
No body

No Content