Skip to main content
GET
/
api
/
v1
/
auto-topup
/
history
curl "https://app.talkover.ai/api/v1/auto-topup/history?per_page=10" \
  -H "Authorization: Bearer talq_your_environment_token_here"

{
  "success": true,
  "data": [
    {
      "id": "topup-uuid-1",
      "amount": 100.00,
      "currency": "USD",
      "trigger": "threshold",
      "status": "succeeded",
      "balance_before": 42.00,
      "balance_after": 142.00,
      "payment_method_id": "pm_uuid_1",
      "transaction_id": "txn_uuid_1",
      "created_at": "2024-01-10T14:30:00Z"
    },
    {
      "id": "topup-uuid-2",
      "amount": 200.00,
      "currency": "USD",
      "trigger": "scheduled",
      "status": "failed",
      "failure_reason": "card_declined",
      "payment_method_id": "pm_uuid_1",
      "created_at": "2024-01-01T08:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total": 23,
    "last_page": 3
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Auto Topup History

List recent auto topup recharge events for your environment, including amount, status, and the trigger (threshold or scheduled).

​
Endpoint

GET /api/v1/auto-topup/history

​
Query Parameters

​
per_page
integer
Items per page. Range: 1–100. Default: 25.
​
page
integer
Page number. Default: 1.

​
Request Headers

​
Authorization
string
required
Bearer token. Format: Bearer talq_your_environment_token_here

​
Examples

curl "https://app.talkover.ai/api/v1/auto-topup/history?per_page=10" \
  -H "Authorization: Bearer talq_your_environment_token_here"

​
Response

{
  "success": true,
  "data": [
    {
      "id": "topup-uuid-1",
      "amount": 100.00,
      "currency": "USD",
      "trigger": "threshold",
      "status": "succeeded",
      "balance_before": 42.00,
      "balance_after": 142.00,
      "payment_method_id": "pm_uuid_1",
      "transaction_id": "txn_uuid_1",
      "created_at": "2024-01-10T14:30:00Z"
    },
    {
      "id": "topup-uuid-2",
      "amount": 200.00,
      "currency": "USD",
      "trigger": "scheduled",
      "status": "failed",
      "failure_reason": "card_declined",
      "payment_method_id": "pm_uuid_1",
      "created_at": "2024-01-01T08:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total": 23,
    "last_page": 3
  }
}

​
Trigger Values

  • threshold — fired because balance dropped below threshold_amount
  • scheduled — fired on a configured day of month
  • test — manual test recharge via Test Auto Topup

​
Status Values

  • pending — payment in flight
  • succeeded — payment captured, balance credited
  • failed — payment declined or errored