Skip to content

Read an owner purchase intent

GET
/dashboard/v1/merchants/{merchantId}/{mode}/purchase_intents/{id}
curl --request GET \
--url https://api.xaalis.org/dashboard/v1/merchants/example/test/purchase_intents/example \
--cookie better-auth.session_token=<better-auth.session_token>
merchantId
required
string
mode
required
string
Allowed values: test live
id
required
string

Intent

Media typeapplication/json
object
object
required
string
Allowed values: agent_purchase_intent
id
required
string
wallet_id
required
string
card_id
required
string
livemode
required
boolean
currency
required
string
Allowed values: USD
action_id
required
string
merchant_name
required
string
<= 100 characters
max_amount
required
integer
>= 1 <= 100000000
reason
required
string
status
required
string
Allowed values: approved pending_owner declined expired consumed
expires_at
required
string
created_at
required
string
Example
{
"object": "agent_purchase_intent",
"currency": "USD",
"status": "approved"
}

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Authentication required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Policy limit or insufficient funds

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Rate limited

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Service unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}