Sign in
purchase

Resolve a purchase request by its blockchain identifier. (READ access required)

Changed on

Resolves a purchase request by its blockchain identifier.

post/purchase/resolve-blockchain-identifier

Request

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

Request body

blockchainIdentifierstring required

The blockchain identifier to resolve

network'Preprod' | 'Mainnet' required

The network the purchases were made on

filterSmartContractAddressstring nullable

The smart contract address of the payment source

includeHistorystring

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

Example request

{
  "blockchainIdentifier": "blockchain_identifier",
  "network": "Preprod",
  "includeHistory": "false"
}

Response

Purchase request resolved

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",
    "blockchainIdentifier": "blockchain_identifier",
    "agentIdentifier": "agent_identifier",
    "lastCheckedAt": null,
    "payByTime": null,
    "submitResultTime": "0",
    "unlockTime": "0",
    "externalDisputeUnlockTime": "0",
    "requestedById": "requester_id",
    "onChainState": null,
    "collateralReturnLovelace": null,
    "cooldownTime": 0,
    "cooldownTimeOtherParty": 0,
    "inputHash": "input_hash",
    "resultHash": "",
    "NextAction": {
      "requestedAction": "FundsLockingRequested",
      "errorType": null,
      "errorNote": null
    },
    "CurrentTransaction": null,
    "TransactionHistory": [],
    "PaidFunds": [
      {
        "unit": "",
        "amount": "10000000"
      }
    ],
    "PaymentSource": {
      "id": "payment_source_id",
      "network": "Preprod",
      "smartContractAddress": "address",
      "policyId": "policy_id"
    },
    "SellerWallet": null,
    "SmartContractWallet": null,
    "metadata": null,
    "WithdrawnForSeller": [],
    "WithdrawnForBuyer": [],
    "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"
  }
}

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

    • info

      added the required property / to the response with the status

  • 87b151d07425Revision changes
    • breaking

      removed the required property / from the response with the status

    • 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