Product
REST API
Full programmatic access to actors and transactions. Create users, query purchase history, and build custom experiences.
Core endpoints
Everything you need to manage actors and query transactions.
POST
/v1/actorsCreate a new actor (user) in your applicationGET
/v1/actors/:idRetrieve actor details and linked accountsGET
/v1/actors/:id/transactionsQuery transactions for a specific actorGET
/v1/transactionsQuery transactions with filters (date, amount, merchant)Actors API
Actors represent your users. Create them, link bank accounts, and query their transactions.
Create an actor
POST /v1/actors
{
"external_id": "user_123",
"email": "john@example.com",
"name": "John Doe"
}Response
201 Created
{
"id": "act_abc123",
"external_id": "user_123",
"email": "john@example.com",
"name": "John Doe",
"created_at": "2024-01-15T10:00:00Z"
}Transactions API
Query transactions with powerful filters for date ranges, amounts, and merchants.
GET /v1/actors/act_abc123/transactions?limit=10
{
"data": [
{
"id": "txn_xyz789",
"amount": 4250,
"currency": "USD",
"merchant": {
"name": "Starbucks",
"category": "Coffee Shops"
},
"timestamp": "2024-01-15T10:30:00Z"
},
{
"id": "txn_xyz790",
"amount": 8999,
"currency": "USD",
"merchant": {
"name": "Amazon",
"category": "Online Shopping"
},
"timestamp": "2024-01-14T15:45:00Z"
}
],
"has_more": true,
"cursor": "cur_next123"
}