Delete destination

Deletes a specific destination from a payment-attempt transaction by transactionId and name, ensuring funds are directed to the correct recipients.

Deletes a specific destination from an existing payment-attempt transaction, using transactionId and name. This endpoint enables you to modify the recipients associated with the payment, which is important if a destination is incorrect or needs to be changed. By managing destinations accurately, you ensure that funds are directed to the appropriate parties upon payment completion.

delete

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.

namestringrequired

Name of the method selected for the destination of funds.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/payment-attempts/{transactionId}/destinations/{name}' \
  --header 'x-api-key: YOUR_API_KEY'

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.