Sign in
payment-source

Delete an existing payment source. (+ADMIN access required)

Changed on

Deletes a payment source. WARNING will also delete all associated wallets and transactions.

delete/payment-source-extended

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/payment-source-extended
  • Auth: API key in header token

Request body

idstring required

The id of the payment source to be deleted

Example request

{
  "id": "unique_cuid_v2_auto_generated"
}

Response

Payment source deleted

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "id": "cuid_v2_auto_generated",
    "createdAt": "1970-01-20T20:00:36.260Z",
    "updatedAt": "1970-01-20T20:00:36.260Z",
    "network": "Mainnet",
    "paymentSourceType": "Web3CardanoV1",
    "requiredAdminSignatures": null,
    "policyId": "policy_id",
    "smartContractAddress": "address_of_the_smart_contract",
    "contractSyncStatus": "in_sync",
    "PaymentSourceConfig": {
      "rpcProviderApiKey": "rpc_provider_api_key_blockfrost",
      "rpcProvider": "Blockfrost"
    },
    "lastIdentifierChecked": "identifier",
    "syncInProgress": true,
    "lastCheckedAt": "1970-01-20T20:00:36.260Z",
    "AdminWallets": [
      {
        "walletAddress": "wallet_address",
        "order": 0
      },
      {
        "walletAddress": "wallet_address",
        "order": 1
      },
      {
        "walletAddress": "wallet_address",
        "order": 2
      }
    ],
    "FeeReceiverNetworkWallet": {
      "walletAddress": "wallet_address"
    },
    "PurchasingWalletsCount": 1,
    "SellingWalletsCount": 1,
    "feeRatePermille": 50
  }
}

Changes

  • 315a2a763fb7Revision changes
    • breaking

      the response property // became optional for the status

  • 87b151d07425Revision changes
    • info

      the response property // became required for the status