Skip to content

List funding and reclaim transfers for an agent wallet

GET
/v1/agent-wallets/{id}/transfers
curl --request GET \
--url 'http://localhost:4000/v1/agent-wallets/example/transfers?limit=20' \
--header 'Authorization: Bearer <token>'
id
required
string
limit
integer
default: 20 >= 1 <= 100
starting_after
string

Wallet transfers

Media typeapplication/json
object
object
required
string
Allowed values: list
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: agent_wallet_transfer
wallet_id
required
string
livemode
required
boolean
direction
required
string
Allowed values: fund reclaim
amount
required
integer
status
required
string
Allowed values: pending succeeded failed
currency
required
string
Allowed values: XOF
failure_reason
required
string | null
created_at
required
string
updated_at
required
string
has_more
required
boolean
Example
{
"object": "list",
"data": [
{
"object": "agent_wallet_transfer",
"direction": "fund",
"status": "pending",
"currency": "XOF"
}
]
}

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 error

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"
}
}

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; see Retry-After response header

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