Arka (Paymaster) API calls
/add-policy
Creates a new policy with the provided details.
POST
/
add-policy
Example values you can use to demo the API:
{
"walletAddress": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"name": "Sample Policy",
"description": "This is a sample policy",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": false,
"enabledChains": [
80002
],
"supportedEPVersions": ["EPV_06", "EPV_07"],
"isPerpetual": false,
"startTime": "2024-06-26T00:40:00.000Z",
"endTime": "2024-06-27T23:59:59.999Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": 5000,
"globalMaximumNative": 1000,
"globalMaximumOpCount": 1000,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": 100,
"perUserMaximumNative": 200,
"perUserMaximumOpCount": 50,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": 10,
"perOpMaximumNative": 20
}
Example response:
{
"createdAt": "2024-06-30T17:39:26.938Z",
"updatedAt": "2024-06-30T17:39:26.939Z",
"id": 5,
"walletAddress": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"name": "Sample Policy",
"description": "This is a sample policy",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": false,
"enabledChains": [
80002
],
"supportedEPVersions": [
"EPV_06",
"EPV_07"
],
"isPerpetual": false,
"startTime": "2024-06-26T00:40:00.000Z",
"endTime": "2024-06-27T23:59:59.999Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": "5000.0000",
"globalMaximumNative": "1000.000000000000000000",
"globalMaximumOpCount": 1000,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": "100.0000",
"perUserMaximumNative": "200.000000000000000000",
"perUserMaximumOpCount": 50,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": "10.0000",
"perOpMaximumNative": "20.000000000000000000",
"addressAllowList": null,
"addressBlockList": null
}
Headers
apikey
string
requiredAPI key for authentication
Body
application/json
walletAddress
string
requiredname
string
requireddescription
string
isPublic
boolean
requiredisEnabled
boolean
requiredisApplicableToAllNetworks
boolean
enabledChains
integer[]
supportedEPVersions
string[]
isPerpetual
boolean
startTime
string
endTime
string
globalMaximumApplicable
boolean
globalMaximumUsd
number
globalMaximumNative
number
globalMaximumOpCount
number
perUserMaximumApplicable
boolean
perUserMaximumUsd
number
perUserMaximumNative
number
perUserMaximumOpCount
number
perOpMaximumApplicable
boolean
perOpMaximumUsd
number
perOpMaximumNative
number
Response
201 - application/json
createdAt
string
updatedAt
string
id
integer
walletAddress
string
name
string
description
string
isPublic
boolean
isEnabled
boolean
isApplicableToAllNetworks
boolean
enabledChains
integer[]
supportedEPVersions
string[]
isPerpetual
boolean
startTime
string
endTime
string
globalMaximumApplicable
boolean
globalMaximumUsd
string
globalMaximumNative
string
globalMaximumOpCount
integer
perUserMaximumApplicable
boolean
perUserMaximumUsd
string
perUserMaximumNative
string
perUserMaximumOpCount
integer
perOpMaximumApplicable
boolean
perOpMaximumUsd
string
perOpMaximumNative
string
addressAllowList
string[] | null
addressBlockList
string[] | null