Skip to content

docs: clarify expiresAt is Unix seconds, warn against milliseconds #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
walletconnect-agent wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: clarify expiresAt is Unix seconds, warn against milliseconds #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6e7dfe
docs: clarify expiresAt is Unix seconds, warn against milliseconds
claude Jun 9, 2026
adb834f
docs: simplify expiresAt description, drop milliseconds warning
claude Jun 9, 2026
0b90c68
docs: fix default expiresAt to 15 minutes (not 5)
claude Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions api/2026-02-18.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1216,7 +1216,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -1405,7 +1405,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters or API version",
"description": "Bad request \u2014 invalid parameters or API version",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -1500,7 +1500,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid partner API key",
"description": "Unauthorized \u2014 missing or invalid partner API key",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -1594,7 +1594,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2243,7 +2243,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key, or missing merchant id",
"description": "Unauthorized \u2014 missing or invalid API key, or missing merchant id",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2621,7 +2621,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -2789,7 +2789,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters or API version",
"description": "Bad request \u2014 invalid parameters or API version",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2884,7 +2884,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key, or missing merchant id",
"description": "Unauthorized \u2014 missing or invalid API key, or missing merchant id",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2986,7 +2986,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3739,7 +3739,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -4732,7 +4732,7 @@
"Crypto Settlement"
],
"summary": "Create crypto settlements",
"description": "Register one or more crypto settlement destinations for the merchant. Each entry pairs a [CAIP-19](https://chainagnostic.org/CAIPs/caip-19) `asset` with a [CAIP-10](https://chainagnostic.org/CAIPs/caip-10) `destination` wallet on the same chain. Each `(merchant, asset)` pair must be unique — registering the same asset twice returns `settlement_asset_conflict`.",
"description": "Register one or more crypto settlement destinations for the merchant. Each entry pairs a [CAIP-19](https://chainagnostic.org/CAIPs/caip-19) `asset` with a [CAIP-10](https://chainagnostic.org/CAIPs/caip-10) `destination` wallet on the same chain. Each `(merchant, asset)` pair must be unique \u2014 registering the same asset twice returns `settlement_asset_conflict`.",
"parameters": [
{
"name": "Idempotency-Key",
Expand Down Expand Up @@ -5468,7 +5468,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters",
"description": "Bad request \u2014 invalid parameters",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -5539,7 +5539,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key",
"description": "Unauthorized \u2014 missing or invalid API key",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -5633,7 +5633,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -6379,7 +6379,8 @@
"integer",
"null"
],
"format": "int64"
"format": "int64",
"description": "Optional custom expiration timestamp (Unix seconds since epoch). Must be in the future if provided. If not provided, defaults to 15 minutes from now."
},
"referenceId": {
"type": "string"
Expand Down Expand Up @@ -7344,7 +7345,7 @@
},
{
"$ref": "#/components/schemas/PaymentsSettlementInformation",
"description": "Settlement metadata for the MTA → destination transfer. Null when\nsettlement has not completed yet (pending, non-MTA flows, or\npre-confirmation)."
"description": "Settlement metadata for the MTA \u2192 destination transfer. Null when\nsettlement has not completed yet (pending, non-MTA flows, or\npre-confirmation)."
}
]
},
Expand Down Expand Up @@ -7383,7 +7384,7 @@
"properties": {
"unit": {
"type": "string",
"description": "Settlement unit — the asset or currency used in the settlement\ntransfer. Uses the same unit format as payment amounts\n(e.g. \"caip19/eip155:1/erc20:0xA0b86...\" for crypto,\n\"iso4217/USD\" for fiat).",
"description": "Settlement unit \u2014 the asset or currency used in the settlement\ntransfer. Uses the same unit format as payment amounts\n(e.g. \"caip19/eip155:1/erc20:0xA0b86...\" for crypto,\n\"iso4217/USD\" for fiat).",
"example": "iso4217/USD"
}
}
Expand Down Expand Up @@ -7423,11 +7424,11 @@
"properties": {
"amount": {
"$ref": "#/components/schemas/PaymentsSettlementAmount",
"description": "Settlement amount — the asset/currency and value transferred."
"description": "Settlement amount \u2014 the asset/currency and value transferred."
},
"txId": {
"type": "string",
"description": "Transaction hash of the MTA → settlement destination transfer."
"description": "Transaction hash of the MTA \u2192 settlement destination transfer."
}
},
"example": {
Expand Down
38 changes: 19 additions & 19 deletions api/2026-02-19.preview.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1216,7 +1216,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -1406,7 +1406,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters or API version",
"description": "Bad request \u2014 invalid parameters or API version",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -1501,7 +1501,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid partner API key",
"description": "Unauthorized \u2014 missing or invalid partner API key",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -1595,7 +1595,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2244,7 +2244,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key, or missing merchant id",
"description": "Unauthorized \u2014 missing or invalid API key, or missing merchant id",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2622,7 +2622,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -2791,7 +2791,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters or API version",
"description": "Bad request \u2014 invalid parameters or API version",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2886,7 +2886,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key, or missing merchant id",
"description": "Unauthorized \u2014 missing or invalid API key, or missing merchant id",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2988,7 +2988,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3741,7 +3741,7 @@
"schema": {
"type": "string"
},
"description": "Opaque pagination cursor — use the value from `nextCursor` in the previous response."
"description": "Opaque pagination cursor \u2014 use the value from `nextCursor` in the previous response."
},
{
"in": "query",
Expand Down Expand Up @@ -4734,7 +4734,7 @@
"Crypto Settlement"
],
"summary": "Create crypto settlements",
"description": "Register one or more crypto settlement destinations for the merchant. Each entry pairs a [CAIP-19](https://chainagnostic.org/CAIPs/caip-19) `asset` with a [CAIP-10](https://chainagnostic.org/CAIPs/caip-10) `destination` wallet on the same chain. Each `(merchant, asset)` pair must be unique — registering the same asset twice returns `settlement_asset_conflict`.",
"description": "Register one or more crypto settlement destinations for the merchant. Each entry pairs a [CAIP-19](https://chainagnostic.org/CAIPs/caip-19) `asset` with a [CAIP-10](https://chainagnostic.org/CAIPs/caip-10) `destination` wallet on the same chain. Each `(merchant, asset)` pair must be unique \u2014 registering the same asset twice returns `settlement_asset_conflict`.",
"parameters": [
{
"name": "Idempotency-Key",
Expand Down Expand Up @@ -5470,7 +5470,7 @@
}
},
"400": {
"description": "Bad request — invalid parameters",
"description": "Bad request \u2014 invalid parameters",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -5541,7 +5541,7 @@
}
},
"401": {
"description": "Unauthorized — missing or invalid API key",
"description": "Unauthorized \u2014 missing or invalid API key",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -5635,7 +5635,7 @@
}
},
"502": {
"description": "Bad gateway — upstream service returned an error",
"description": "Bad gateway \u2014 upstream service returned an error",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -6414,7 +6414,7 @@
"null"
],
"format": "int64",
"description": "Optional custom expiration timestamp (Unix seconds since epoch).\nMust be in the future if provided. If not provided, defaults to 5 minutes from now."
"description": "Optional custom expiration timestamp (Unix seconds since epoch). Must be in the future if provided. If not provided, defaults to 15 minutes from now."
},
"referenceId": {
"type": "string",
Expand Down Expand Up @@ -7381,7 +7381,7 @@
},
{
"$ref": "#/components/schemas/PaymentsSettlementInformation",
"description": "Settlement metadata for the MTA → destination transfer. Null when\nsettlement has not completed yet (pending, non-MTA flows, or\npre-confirmation)."
"description": "Settlement metadata for the MTA \u2192 destination transfer. Null when\nsettlement has not completed yet (pending, non-MTA flows, or\npre-confirmation)."
}
]
},
Expand Down Expand Up @@ -7420,7 +7420,7 @@
"properties": {
"unit": {
"type": "string",
"description": "Settlement unit — the asset or currency used in the settlement\ntransfer. Uses the same unit format as payment amounts\n(e.g. \"caip19/eip155:1/erc20:0xA0b86...\" for crypto,\n\"iso4217/USD\" for fiat).",
"description": "Settlement unit \u2014 the asset or currency used in the settlement\ntransfer. Uses the same unit format as payment amounts\n(e.g. \"caip19/eip155:1/erc20:0xA0b86...\" for crypto,\n\"iso4217/USD\" for fiat).",
"example": "iso4217/USD"
}
}
Expand Down Expand Up @@ -7460,11 +7460,11 @@
"properties": {
"amount": {
"$ref": "#/components/schemas/PaymentsSettlementAmount",
"description": "Settlement amount — the asset/currency and value transferred."
"description": "Settlement amount \u2014 the asset/currency and value transferred."
},
"txId": {
"type": "string",
"description": "Transaction hash of the MTA → settlement destination transfer."
"description": "Transaction hash of the MTA \u2192 settlement destination transfer."
}
},
"example": {
Expand Down