Skip to main content
POST
/
v1
/
invoices
/
{id}
/
rescan
curl --request POST \
  --url https://api.swiftpay.finance/v1/invoices/{id}/rescan \
  --header 'Content-Type: application/json' \
  --header 'X-Swift-Key: <api-key>' \
  --data '
{
  "chain": "ethereum",
  "fromBlock": 19450000
}
'
{
  "success": true,
  "message": "Transaction scan completed",
  "data": {
    "found": 2
  }
}

Authorizations

​
X-Swift-Key
string
header
required

Your secret API key (sk_live_*). Keep this server-side only.

Path Parameters

​
id
string<uuid>
required

Invoice ID (UUID)

Body

application/json
​
chain
string
required

Network ID to scan for missed transfers (e.g. ethereum, base, polygon).

Example:

"ethereum"

​
txHash
string

Specific on-chain transaction hash to check. When provided, only the block containing this transaction is scanned — much faster than a range scan.

Example:

"0xabc123def456..."

​
fromBlock
integer<uint64>

Block number to start scanning from. When omitted (and txHash is not set), defaults to the current head minus 50,000 blocks.

Example:

19450000

Response

Scan completed

​
success
enum<boolean>
Available options:
true
​
message
string
​
data
object