payment-source

List payment sources with their public details augmented with internal configuration and sync status information. (read access required)

Changed on

Gets the payment contracts including the status.

get/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

Query parameters

takenumber

The number of payment sources to return

cursorIdstring

Used to paginate through the payment sources

network'Preprod' | 'Mainnet'

Restrict results to a single Cardano network (still bounded by the key network limit)

Response

Payment source status

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "ExtendedPaymentSources": [
      {
        "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,
        "feeRatePermille": 50,
        "syncInProgress": true,
        "policyId": "policy_id",
        "smartContractAddress": "address_of_the_smart_contract",
        "contractSyncStatus": "in_sync",
        "AdminWallets": [
          {
            "walletAddress": "wallet_address",
            "order": 0
          },
          {
            "walletAddress": "wallet_address",
            "order": 1
          },
          {
            "walletAddress": "wallet_address",
            "order": 2
          }
        ],
        "PurchasingWalletsCount": 1,
        "SellingWalletsCount": 1,
        "FeeReceiverNetworkWallet": {
          "walletAddress": "wallet_address"
        },
        "lastCheckedAt": "1970-01-20T20:00:36.260Z",
        "lastIdentifierChecked": "identifier",
        "PaymentSourceConfig": {
          "rpcProviderApiKey": "rpc_provider_api_key_blockfrost",
          "rpcProvider": "Blockfrost"
        }
      }
    ]
  }
}

Changes

    • breaking

      the response property //// became optional for the status

    • info

      the response property //// became required for the status