v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
wallets

List all consumptions for a wallet transaction

This endpoint is used to list all consumption records for an inbound wallet transaction. It shows how the credits from this inbound transaction were consumed by outbound transactions. Only available for traceable wallets.

get/wallet_transactions/{lago_id}/consumptions

Path parameters

lago_idstring uuid required
Example:1a901a90-1a90-1a90-1a90-1a901a901a90

Unique identifier assigned to the wallet transaction within the Lago application. Must be an inbound wallet transaction.

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:20

Number of records per page.

Response

Wallet transaction consumptions

Example response

{
  "wallet_transaction_consumptions": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "amount_cents": 5000,
      "credit_amount": "5.0",
      "created_at": "2022-04-29T08:59:51Z",
      "wallet_transaction": {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "lago_wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "lago_credit_note_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "lago_voided_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "status": "settled",
        "source": "manual",
        "transaction_status": "purchased",
        "transaction_type": "inbound",
        "amount": "10.0",
        "credit_amount": "100.0",
        "metadata": [
          {
            "key": "example key",
            "value": "example value"
          },
          {
            "key": "another key",
            "value": "another value"
          }
        ],
        "remaining_amount_cents": 5000,
        "remaining_credit_amount": "5.0",
        "priority": 50,
        "settled_at": "2022-04-29T08:59:51Z",
        "failed_at": "2022-04-29T08:59:51Z",
        "created_at": "2022-04-29T08:59:51Z",
        "name": "Tokens for models 'high-fidelity-boost'",
        "applied_invoice_custom_sections": [
          {
            "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "created_at": "2023-07-06T14:35:58Z",
            "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "invoice_custom_section": {
              "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "name": "EU Bank Details",
              "code": "eu_bank_details",
              "description": "This section contains the bank details for EU customers.",
              "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
              "display_name": "Bank Details:",
              "applied_to_organization": true,
              "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "created_at": "2023-07-06T14:35:58Z"
            }
          }
        ],
        "payment_method": {
          "payment_method_type": "provider",
          "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
        }
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}