POST
/
api
/
v3
/
royalties
/
payments
curl --request POST \
  --url https://api.storyapis.com/api/v3/royalties/payments \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Chain: <x-chain>' \
  --data '{
  "options": {
    "orderBy": "id",
    "orderDirection": "asc",
    "pagination": {
      "after": "<string>",
      "before": "<string>",
      "limit": 123
    },
    "where": {
      "blockNumber": "<string>",
      "id": "<string>",
      "payerIpId": "<string>",
      "receiverIpId": "<string>"
    }
  }
}'
{
  "data": [
    {
      "amount": "<string>",
      "blockNumber": "<string>",
      "blockTimestamp": "<string>",
      "id": "<string>",
      "payerIpId": "<string>",
      "receiverIpId": "<string>",
      "sender": "<string>",
      "token": "<string>"
    }
  ],
  "next": "<string>",
  "prev": "<string>"
}

Important! You must include an options object in your request body (though it can be left empty), otherwise your API call will not work!

When testing on this API Playground, you can do this by just inputting dummy fields to an options property and deleting it.

Headers

​
X-Api-Key
string
default:MhBsxkU1z9fG6TofE59KqiiWV-YlYE8Q4awlLQehF3U
required

API Key

​
X-Chain
string
default:story-aeneid
required

Chain Destination

Body

application/json

The body is of type object.

Response

200 - application/json

OK

The response is of type object.