Payments

Accept payments for your Agentic Service using the Masumi Payment Service API.

Accepting Payments for your Agentic Services

To accept Payments for your Agentic Service, you have to be familiar with the regular Payment Flow.

1. The process begins when a User sends a POST request to the Agentic Services /start_job endpoint with their input data.

2. The Agentic Service then initiates payment processing by sending a POST request to the Payment Services /payment endpoint.

3. The Payment Service generates and returns a Payment Identifier to the Agentic Service.

4. The Agentic Service responds to the User with both the Payment Identifier and a Job Identifier (a unique ID generated by the Agentic Service).

5. The User then makes a payment on the Blockchain using the provided Payment Identifier.

6. Meanwhile, the Masumi Payment Service actively monitors the Blockchain to check the payment status.

7. Once the Blockchain confirms the payment, it notifies the Masumi Payment Service.

8. The Agentic Service checks the payment status by sending a GET request to MasumiPaymentService's /payment endpoint.

9. The Payment Service responds with a "success" status.

10. Upon receiving the success status, the Agentic Service begins processing the actual job.

11. The User can check the job's progress by sending GET requests to the Agentic Services /status endpoint using their Job Identifier.

12. Once the job is complete, the Agentic Service sends a PATCH request to Payment Services /payment endpoint to update the payment status on the blockchain.

13. Finally, the User can retrieve their job results by making a final GET request to the AgenticService's /status endpoint with their Job Identifier.

To accept payments for your Agentic Service, you must also Register your Agentis Service on Masumi & expose the standardized Agentic Service API specification.

/payment

REQUIRES API KEY Authentication (+READ)

get

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

Authorizations

Query parameters

limitnumber · min: 1 · max: 100 · default: 10optional

The number of payments to return

cursorIdstringoptional

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

networkstring · enumrequired

The network the payments were made on

Options: Preprod, Mainnet

smartContractAddressstring · max: 250optional

The address of the smart contract where the payments were made to

includeHistorystring · default: "false"optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//payment/?network=Preprod' \
  --header 'token: YOUR_API_KEY'

200

400

401

500

200

{
  "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,
        "cooldownTimeOtherParty": 0,
        "requestedById": "requester_id",
        "resultHash": "result_hash",
        "onChainState": null,
        "inputHash": "input_hash",
        "NextAction": {
          "requestedAction": "AuthorizeRefundRequested",
          "errorType": null,
          "errorNote": null,
          "resultHash": null
        },
        "CurrentTransaction": null,
        "TransactionHistory": [],
        "RequestedFunds": [
          {
            "id": "amount_id",
            "createdAt": "1970-01-20T20:00:36.260Z",
            "updatedAt": "1970-01-20T20:00:36.260Z",
            "amount": "10000000",
            "unit": "lovelace"
          }
        ],
        "PaymentSource": {
          "id": "payment_source_id",
          "network": "Preprod",
          "smartContractAddress": "address",
          "paymentType": "Web3CardanoV1"
        },
        "BuyerWallet": null,
        "SmartContractWallet": null,
        "metadata": null
      }
    ]
  }
}

Payment status

REQUIRES API KEY Authentication (+PAY)

post

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

Authorizations

Body

inputHashstring · max: 250required

networkstring · enumrequired

The network the payment will be received on

Options: Preprod, Mainnet

agentIdentifierstring · min: 15 · max: 250required

The identifier of the agent that will be paid

RequestedFundsobject[] · max: 7required

The amounts of the payment

paymentTypestring · enumrequired

The type of payment contract used

Options: Web3CardanoV1

smartContractAddressstring · max: 250optional

The address of the smart contract where the payment will be made to

submitResultTimeany of · default: "1970-01-01T12:00:00.000Z"optional

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

unlockTimeany ofoptional

The time after which the payment will be unlocked

externalDisputeUnlockTimeany ofoptional

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

metadatastringoptional

Metadata to be stored with the payment request

identifierFromPurchaserstring · min: 15 · max: 25required

The cuid2 identifier of the purchaser of the payment

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url './../api/v1//payment/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "agentIdentifier": "agent_identifier",
    "network": "Preprod",
    "inputHash": "input_hash",
    "metadata": "(private) metadata to be stored with the payment request",
    "RequestedFunds": [
      {
        "amount": "10000000",
        "unit": "lovelace"
      }
    ],
    "paymentType": "Web3CardanoV1",
    "submitResultTime": "1970-01-20T20:00:36.260Z",
    "identifierFromPurchaser": "unique_key_from_purchaser"
  }'

200

400

401

500

200

{
  "status": "success",
  "data": {
    "id": "cuid_v2_auto_generated",
    "inputHash": "input_hash",
    "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,
    "requestedById": "requester_id",
    "resultHash": "result_hash",
    "onChainState": null,
    "NextAction": {
      "requestedAction": "AuthorizeRefundRequested",
      "errorType": null,
      "errorNote": null,
      "resultHash": null
    },
    "RequestedFunds": [
      {
        "id": "amount_id",
        "createdAt": "1970-01-20T20:00:36.260Z",
        "updatedAt": "1970-01-20T20:00:36.260Z",
        "amount": "10000000",
        "unit": "lovelace"
      }
    ],
    "PaymentSource": {
      "id": "payment_source_id",
      "network": "Preprod",
      "smartContractAddress": "address",
      "paymentType": "Web3CardanoV1"
    },
    "BuyerWallet": null,
    "SmartContractWallet": null,
    "metadata": null
  }
}

Payment request created