/payment

Creates a payment request and identifier. This will check incoming payments in the background.

Authorization

API-Key

token<token>

API key authentication via header (token)

In: header

Request Body

application/json

inputHash*string

The hash of the input data of the payment, should be sha256 hash of the input data, therefore needs to be in hex string format

Lengthlength <= 250

network*string

The network the payment will be received on

Value in"Preprod" | "Mainnet"

agentIdentifier*string

The identifier of the agent that will be paid

Length57 <= length <= 250

paymentSourceType?string

Expected payment source type for this request

Value in"Web3CardanoV1" | "Web3CardanoV2"

RequestedFunds?array<>

The amounts of the payment, should be null for fixed amount

Itemsitems <= 7

payByTime?||

The time after which the payment has to be submitted to the smart contract

Default"1970-01-01T12:00:00.000Z"

submitResultTime?||

The time after which the payment has to be submitted to the smart contract

Default"1970-01-01T12:00:00.000Z"

unlockTime?||

The time after which the payment will be unlocked

externalDisputeUnlockTime?||

The time after which the payment will be unlocked for external dispute

metadata?string

Metadata to be stored with the payment request

sellerReturnAddress?string

Optional seller return address. Defaults to the selling hot wallet collection address when available.

Lengthlength <= 250

identifierFromPurchaser*string

A unique nonce from the purchaser. It must be in hex format

Length14 <= length <= 26

Response Body

`application/json`

curl -X POST "https://loading/./../api/v1/payment" \  -H "Content-Type: application/json" \  -d '{    "agentIdentifier": "agent_identifier",    "network": "Preprod",    "inputHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",    "payByTime": "1970-01-20T20:00:26.260Z",    "metadata": "(private) metadata to be stored with the payment request",    "submitResultTime": "1970-01-20T20:00:36.260Z",    "identifierFromPurchaser": "aabbaabb11221122aabb"  }'

{
  "status": "Success",
  "data": {
    "id": "cuid_v2_auto_generated",
    "blockchainIdentifier": "blockchain_identifier",
    "agentIdentifier": "agent_identifier",
    "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,
    "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"
  }
}

Empty

/payment

Authorization

Request Body

Response Body

200application/json

400

401

500

`application/json`