Skip to main content
GET
/
v1
/
intents
/
{intentId}
Get intent
curl --request GET \
  --url https://api.ledger.so/v1/intents/{intentId} \
  --header 'Api-Key: <api-key>'
{
  "id": "<string>",
  "cardId": "<string>",
  "intentId": "<string>",
  "summary": "<string>",
  "status": "pending",
  "expiresAt": 123,
  "createdAt": 123,
  "expectedAmount": 123,
  "expectedCurrency": "<string>",
  "expectedMerchant": "<string>",
  "tolerance": 123,
  "transactionId": "<string>",
  "matchResult": {
    "amountMatch": true,
    "merchantMatch": true,
    "actualAmount": 123,
    "actualMerchant": "<string>"
  },
  "matchedAt": 123
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

​
intentId
string
required

The intent ID

Response

Intent details

​
id
string
required

Internal intent ID

​
cardId
string
required
​
intentId
string
required

Customer-provided intent ID

​
summary
string
required
​
status
enum<string>
required

pending=awaiting transaction, matched=transaction matched within tolerance, mismatched=transaction outside tolerance, expired=TTL reached, canceled=manually canceled

Available options:
pending,
matched,
mismatched,
expired,
canceled
​
expiresAt
integer
required

Unix timestamp when intent expires

​
createdAt
integer
required
​
expectedAmount
integer
​
expectedCurrency
string
​
expectedMerchant
string
​
tolerance
integer
​
transactionId
string

ID of matched transaction (if status is matched or mismatched)

​
matchResult
object

Match details (populated after transaction)

​
matchedAt
integer

Unix timestamp when transaction was matched