Masumi Logo

/payment

Gets the payment status. It needs to be created first with a POST request.

GET
/payment
token<token>

API key authentication via header (token)

In: header

Query Parameters

limit?number

The number of payments to return

Default10
Range1 <= value <= 100
cursorId?string

Used to paginate through the payments. If this is provided, cursorId is required

networkstring

The network the payments were made on

Value in"Preprod" | "Mainnet"
filterSmartContractAddress?string | null

The smart contract address of the payment source

includeHistory?string

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

Default"false"

Response Body

curl -X GET "https://loading/./../api/v1/payment/?limit=10&cursorId=string&network=Preprod&filterSmartContractAddress=string&includeHistory=false"
{
  "status": "success",
  "data": {
    "Payments": [
      {
        "id": "cuid_v2_auto_generated",
        "blockchainIdentifier": "blockchain_identifier",
        "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,
        "requestedById": "requester_id",
        "resultHash": "result_hash",
        "onChainState": null,
        "inputHash": "input_hash",
        "NextAction": {
          "requestedAction": "AuthorizeRefundRequested",
          "errorType": null,
          "errorNote": null,
          "resultHash": null
        },
        "CurrentTransaction": null,
        "TransactionHistory": [],
        "RequestedFunds": [
          {
            "amount": "10000000",
            "unit": ""
          }
        ],
        "PaymentSource": {
          "id": "payment_source_id",
          "network": "Preprod",
          "smartContractAddress": "address",
          "policyId": "policy_id",
          "paymentType": "Web3CardanoV1"
        },
        "WithdrawnForSeller": [],
        "WithdrawnForBuyer": [],
        "BuyerWallet": null,
        "SmartContractWallet": null,
        "metadata": null
      }
    ]
  }
}
Empty
Empty
Empty