Sign in
payment

Diff payments by on-chain-state/result timestamp (READ access required)

Changed on

Returns payments whose on-chain state or result hash changed since lastUpdate.

get/payment/diff/onchain-state-or-result

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/diff/onchain-state-or-result
  • Auth: API key in header token

Query parameters

limitnumber

The number of payments to return

cursorIdstring

Pagination cursor (payment id). Used as tie-breaker when lastUpdate equals a payment change timestamp

string date
OR
string date-time
OR
string date-time
network'Preprod' | 'Mainnet' required

The network the payments were made on

filterSmartContractAddressstring nullable

The smart contract address of the payment source. When omitted with no explicit payment source type, payment diff endpoints default to Web3CardanoV1 for backwards compatibility. Supplying this field queries that exact V1 or V2 source.

filterPaymentSourceType'Web3CardanoV1' | 'Web3CardanoV2'

Filter by payment source type. When omitted with no smart-contract-address filter, payment diff endpoints default to Web3CardanoV1 for backwards compatibility.

includeHistorystring

Whether to include the full transaction and status history of the payments

Response

Payment diff

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "Payments": [
      {
        "id": "cuid_v2_auto_generated",
        "blockchainIdentifier": "blockchain_identifier",
        "agentIdentifier": "agent_identifier",
        "agentName": "Example Agent",
        "pricingType": "Fixed",
        "createdAt": "1970-01-20T20:00:36.260Z",
        "updatedAt": "1970-01-20T20:00:36.260Z",
        "submitResultTime": "0",
        "unlockTime": "0",
        "externalDisputeUnlockTime": "0",
        "lastCheckedAt": null,
        "cooldownTime": 0,
        "payByTime": null,
        "cooldownTimeOtherParty": 0,
        "collateralReturnLovelace": null,
        "buyerReturnAddress": null,
        "sellerReturnAddress": null,
        "requestedById": "requester_id",
        "resultHash": "result_hash",
        "onChainState": null,
        "forceLayer": null,
        "inputHash": "input_hash",
        "NextAction": {
          "requestedAction": "AuthorizeRefundRequested",
          "errorType": null,
          "errorNote": null,
          "resultHash": null
        },
        "CurrentTransaction": null,
        "RequestedFunds": [
          {
            "unit": "",
            "amount": "10000000"
          }
        ],
        "PaymentSource": {
          "id": "payment_source_id",
          "network": "Preprod",
          "paymentSourceType": "Web3CardanoV1",
          "smartContractAddress": "address",
          "policyId": "policy_id"
        },
        "WithdrawnForSeller": [],
        "WithdrawnForBuyer": [],
        "BuyerWallet": null,
        "SmartContractWallet": null,
        "metadata": null,
        "totalBuyerCardanoFees": 0,
        "totalSellerCardanoFees": 0,
        "nextActionOrOnChainStateOrResultLastChangedAt": "1970-01-20T20:00:36.260Z",
        "nextActionLastChangedAt": "1970-01-20T20:00:36.260Z",
        "onChainStateOrResultLastChangedAt": "1970-01-20T20:00:36.260Z",
        "TransactionHistory": []
      }
    ]
  }
}

Changes

  • 315a2a763fb7Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the required property /// to the response with the status

  • 87b151d07425Revision changes
    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status