1c90c5e. It covers 7 client methods in this group.
Input schemas describe the typed client call before path/query/body mapping.
Output schemas describe the envelope’s
data, not the full HTTP response.
Custom refinements, transforms, and runtime permissions are enforced by the
shared Zod
contract.
Read transport rules before copying a client
object into an HTTP body. Designed methods reject live calls; optional funding
still requires provider configuration.Methods at a glance
| Client method | HTTP route | Access | Availability |
|---|---|---|---|
funding.status | GET /v1/funding/status | session | Core live |
funding.requestGas | POST /v1/funding/gas | session | Core live |
funding.auroraConfig | GET /v1/funding/aurora | public | Optional — check configuration |
funding.auroraPreview | POST /v1/funding/aurora/preview | session | Optional — check configuration |
funding.auroraCreateDeposit | POST /v1/funding/aurora/deposits | session | Optional — check configuration |
funding.auroraDeposit | GET /v1/funding/aurora/deposits/:id | session | Optional — check configuration |
insights.forDistributor | GET /v1/merchant/distributors/:address/insights | session | Core live |
funding.status
GET/v1/funding/status · Core live · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Client input fields
| Field | Type | Required | Constraints |
|---|---|---|---|
address | string | No | Pattern validated; see input schema |
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"address": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
}
}
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"monWei": {
"$ref": "#/$defs/__schema0"
},
"sdusd": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"sdusdAllowanceToProtocol": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"blockNumber": {
"$ref": "#/$defs/__schema0"
},
"chainId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"faucetLimit": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"covers": {
"anyOf": [
{
"type": "object",
"properties": {
"createNode": {
"type": "boolean"
},
"purchase": {
"type": "boolean"
},
"finalizeSale": {
"type": "boolean"
},
"claimRewards": {
"type": "boolean"
}
},
"required": [
"createNode",
"purchase",
"finalizeSale",
"claimRewards"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"gas": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"eligible",
"sending",
"received",
"already_received",
"balance_sufficient",
"device_limit",
"station_empty",
"wallet_account",
"failed",
"unavailable",
"not_configured"
]
},
"dripAmount": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"lastDripAt": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
},
"lastDripTxHash": {
"anyOf": [
{
"type": "string",
"pattern": "^0x[0-9a-fA-F]{64}$"
},
{
"type": "null"
}
]
},
"nextEligibleAt": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"dripAmount",
"lastDripAt",
"lastDripTxHash",
"nextEligibleAt"
],
"additionalProperties": false
}
},
"required": [
"monWei",
"sdusd",
"sdusdAllowanceToProtocol",
"blockNumber",
"chainId",
"faucetLimit",
"covers",
"gas"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "string"
},
"__schema1": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
}
}
funding.requestGas
POST/v1/funding/gas · Core live · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Client input fields
No fields. Use an empty object for the client method input.
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"txHash": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{64}$"
},
"amount": {
"type": "string"
}
},
"required": ["txHash", "amount"],
"additionalProperties": false
}
funding.auroraConfig
GET/v1/funding/aurora · Optional — check configuration · Access: public. Source definition.
Client input fields
No fields. Use an empty object for the client method input.
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "aurora"
},
"configured": {
"type": "boolean"
},
"destinationChainId": {
"type": "number",
"const": 143
},
"destinationNetwork": {
"type": "string",
"const": "Monad Mainnet"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"provider",
"configured",
"destinationChainId",
"destinationNetwork",
"sources",
"destinations"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"blockchain": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"networkName": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"chainId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 36
},
"contractAddress": {
"anyOf": [
{
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
{
"type": "null"
}
]
}
},
"required": [
"assetId",
"blockchain",
"networkName",
"chainId",
"symbol",
"decimals",
"contractAddress"
],
"additionalProperties": false
}
}
}
funding.auroraPreview
POST/v1/funding/aurora/preview · Optional — check configuration · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Client input fields
| Field | Type | Required | Constraints |
|---|---|---|---|
originAsset | string | Yes | Min length: 1; Max length: 256 |
destinationAsset | string | Yes | Min length: 1; Max length: 256 |
amount | string | Yes | Max length: 78; Pattern validated; see input schema |
refundAddress | string | Yes | Pattern validated; see input schema |
slippageBps | integer | No | Minimum: 10; Maximum: 300; Default: 50 |
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"originAsset": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"destinationAsset": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"amount": {
"$ref": "#/$defs/__schema0"
},
"refundAddress": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
"slippageBps": {
"default": 50,
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": ["originAsset", "destinationAsset", "amount", "refundAddress"],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "string",
"maxLength": 78,
"pattern": "^(0|[1-9]\\d*)$"
}
}
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "aurora"
},
"destinationChainId": {
"type": "number",
"const": 143
},
"source": {
"$ref": "#/$defs/__schema0"
},
"destination": {
"$ref": "#/$defs/__schema0"
},
"recipient": {
"$ref": "#/$defs/__schema1"
},
"refundAddress": {
"$ref": "#/$defs/__schema1"
},
"amountIn": {
"$ref": "#/$defs/__schema2"
},
"amountOut": {
"$ref": "#/$defs/__schema2"
},
"minAmountOut": {
"$ref": "#/$defs/__schema2"
},
"slippageBps": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refundFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"withdrawFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"timeEstimateSeconds": {
"type": "number",
"minimum": 0
},
"quotedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"provider",
"destinationChainId",
"source",
"destination",
"recipient",
"refundAddress",
"amountIn",
"amountOut",
"minAmountOut",
"slippageBps",
"refundFee",
"withdrawFee",
"timeEstimateSeconds",
"quotedAt"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"blockchain": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"networkName": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"chainId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 36
},
"contractAddress": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
}
},
"required": [
"assetId",
"blockchain",
"networkName",
"chainId",
"symbol",
"decimals",
"contractAddress"
],
"additionalProperties": false
},
"__schema1": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
"__schema2": {
"type": "string"
}
}
}
funding.auroraCreateDeposit
POST/v1/funding/aurora/deposits · Optional — check configuration · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Idempotency field: requestId. The frontend also sends this value in the idempotency-key header. Preserve the same identifier when resuming the same logical action.
Client input fields
| Field | Type | Required | Constraints |
|---|---|---|---|
originAsset | string | Yes | Min length: 1; Max length: 256 |
destinationAsset | string | Yes | Min length: 1; Max length: 256 |
amount | string | Yes | Max length: 78; Pattern validated; see input schema |
refundAddress | string | Yes | Pattern validated; see input schema |
slippageBps | integer | No | Minimum: 10; Maximum: 300; Default: 50 |
requestId | string | Yes | Format: uuid; Pattern validated; see input schema |
acknowledgeMainnet | true | Yes | See nested schema and runtime validation |
expectedRecipient | string | Yes | Pattern validated; see input schema |
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"originAsset": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"destinationAsset": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"amount": {
"$ref": "#/$defs/__schema0"
},
"refundAddress": {
"$ref": "#/$defs/__schema1"
},
"slippageBps": {
"default": 50,
"type": "integer",
"minimum": 10,
"maximum": 300
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"acknowledgeMainnet": {
"type": "boolean",
"const": true
},
"expectedRecipient": {
"$ref": "#/$defs/__schema1"
}
},
"required": [
"originAsset",
"destinationAsset",
"amount",
"refundAddress",
"requestId",
"acknowledgeMainnet",
"expectedRecipient"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "string",
"maxLength": 78,
"pattern": "^(0|[1-9]\\d*)$"
},
"__schema1": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
}
}
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "aurora"
},
"destinationChainId": {
"type": "number",
"const": 143
},
"source": {
"$ref": "#/$defs/__schema0"
},
"destination": {
"$ref": "#/$defs/__schema0"
},
"recipient": {
"$ref": "#/$defs/__schema1"
},
"refundAddress": {
"$ref": "#/$defs/__schema1"
},
"amountIn": {
"$ref": "#/$defs/__schema2"
},
"amountOut": {
"$ref": "#/$defs/__schema2"
},
"minAmountOut": {
"$ref": "#/$defs/__schema2"
},
"slippageBps": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refundFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"withdrawFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"timeEstimateSeconds": {
"type": "number",
"minimum": 0
},
"quotedAt": {
"$ref": "#/$defs/__schema3"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"createdAt": {
"$ref": "#/$defs/__schema3"
},
"depositAddress": {
"$ref": "#/$defs/__schema1"
},
"deadline": {
"$ref": "#/$defs/__schema3"
},
"state": {
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"KNOWN_DEPOSIT_TX",
"INCOMPLETE_DEPOSIT",
"PROCESSING",
"SUCCESS",
"REFUNDED",
"FAILED"
]
},
"stateSource": {
"type": "string",
"const": "aurora"
},
"statusAvailable": {
"default": true,
"type": "boolean"
},
"observedAt": {
"$ref": "#/$defs/__schema3"
},
"destinationTxHashes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^0x[\\da-fA-F]{64}$"
}
},
"confirmation": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["pending", "verified", "unavailable"]
},
"txHash": {
"anyOf": [
{
"type": "string",
"pattern": "^0x[\\da-fA-F]{64}$"
},
{
"type": "null"
}
]
},
"blockNumber": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
}
},
"required": ["state", "txHash", "blockNumber"],
"additionalProperties": false
}
},
"required": [
"provider",
"destinationChainId",
"source",
"destination",
"recipient",
"refundAddress",
"amountIn",
"amountOut",
"minAmountOut",
"slippageBps",
"refundFee",
"withdrawFee",
"timeEstimateSeconds",
"quotedAt",
"id",
"createdAt",
"depositAddress",
"deadline",
"state",
"stateSource",
"statusAvailable",
"observedAt",
"destinationTxHashes",
"confirmation"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"blockchain": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"networkName": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"chainId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 36
},
"contractAddress": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
}
},
"required": [
"assetId",
"blockchain",
"networkName",
"chainId",
"symbol",
"decimals",
"contractAddress"
],
"additionalProperties": false
},
"__schema1": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
"__schema2": {
"type": "string"
},
"__schema3": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
}
}
funding.auroraDeposit
GET/v1/funding/aurora/deposits/:id · Optional — check configuration · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Client input fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | Format: uuid; Pattern validated; see input schema |
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": ["id"]
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "aurora"
},
"destinationChainId": {
"type": "number",
"const": 143
},
"source": {
"$ref": "#/$defs/__schema0"
},
"destination": {
"$ref": "#/$defs/__schema0"
},
"recipient": {
"$ref": "#/$defs/__schema1"
},
"refundAddress": {
"$ref": "#/$defs/__schema1"
},
"amountIn": {
"$ref": "#/$defs/__schema2"
},
"amountOut": {
"$ref": "#/$defs/__schema2"
},
"minAmountOut": {
"$ref": "#/$defs/__schema2"
},
"slippageBps": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refundFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"withdrawFee": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"timeEstimateSeconds": {
"type": "number",
"minimum": 0
},
"quotedAt": {
"$ref": "#/$defs/__schema3"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"createdAt": {
"$ref": "#/$defs/__schema3"
},
"depositAddress": {
"$ref": "#/$defs/__schema1"
},
"deadline": {
"$ref": "#/$defs/__schema3"
},
"state": {
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"KNOWN_DEPOSIT_TX",
"INCOMPLETE_DEPOSIT",
"PROCESSING",
"SUCCESS",
"REFUNDED",
"FAILED"
]
},
"stateSource": {
"type": "string",
"const": "aurora"
},
"statusAvailable": {
"default": true,
"type": "boolean"
},
"observedAt": {
"$ref": "#/$defs/__schema3"
},
"destinationTxHashes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^0x[\\da-fA-F]{64}$"
}
},
"confirmation": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["pending", "verified", "unavailable"]
},
"txHash": {
"anyOf": [
{
"type": "string",
"pattern": "^0x[\\da-fA-F]{64}$"
},
{
"type": "null"
}
]
},
"blockNumber": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
}
},
"required": ["state", "txHash", "blockNumber"],
"additionalProperties": false
}
},
"required": [
"provider",
"destinationChainId",
"source",
"destination",
"recipient",
"refundAddress",
"amountIn",
"amountOut",
"minAmountOut",
"slippageBps",
"refundFee",
"withdrawFee",
"timeEstimateSeconds",
"quotedAt",
"id",
"createdAt",
"depositAddress",
"deadline",
"state",
"stateSource",
"statusAvailable",
"observedAt",
"destinationTxHashes",
"confirmation"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"blockchain": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"networkName": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"chainId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 36
},
"contractAddress": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
}
},
"required": [
"assetId",
"blockchain",
"networkName",
"chainId",
"symbol",
"decimals",
"contractAddress"
],
"additionalProperties": false
},
"__schema1": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
"__schema2": {
"type": "string"
},
"__schema3": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
}
}
insights.forDistributor
GET/v1/merchant/distributors/:address/insights · Core live · Access: session. Source definition.
An authenticated session is necessary; ownership, merchant/operator scope, and any fresh-confirmation requirements are checked separately by the service.
Client input fields
| Field | Type | Required | Constraints |
|---|---|---|---|
address | string | Yes | Pattern validated; see input schema |
Structural input JSON schema
Structural input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"address": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
}
},
"required": ["address"]
}
Structural output JSON schema
Structural output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["available", "no_history", "none"]
},
"source": {
"type": ["string", "null"]
},
"fetchedAt": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"networks": {
"type": "array",
"items": {
"type": "string"
}
},
"scopeNote": {
"type": "string"
},
"activitySummary": {
"anyOf": [
{
"type": "object",
"properties": {
"transactions": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"lastActiveAt": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
}
},
"required": ["transactions", "lastActiveAt"],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"reviewSignals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": ["label", "reason"],
"additionalProperties": false
}
}
},
"required": [
"status",
"source",
"fetchedAt",
"labels",
"networks",
"scopeNote",
"activitySummary",
"reviewSignals"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
}
}