GEgetlago
wallets

List all wallet transactions

Changed on

This endpoint is used to list all wallet transactions.

get/wallets/{lago_id}/wallet_transactions

Request

Path parameters

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

Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

statusstring
Example:pending

The status of the wallet transaction. Possible values are pending, settled or failed.

transaction_statusstring
Example:purchased

The transaction status of the wallet transaction. Possible values are purchased (with pending or settled status), granted (without invoice_id), voided or invoiced.

transaction_typestring
Example:inbound

The transaction type of the wallet transaction. Possible values are inbound (increasing the wallet balance) or outbound (decreasing the wallet balance).

metadata[key]string
Example:someValue

Filter wallet transactions by metadata. Replace key with the actual metadata key you want to match, and provide the corresponding value. For example, metadata[color]=blue.

Response

Wallet transactions

Example response

{
  "wallet_transactions": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "billing_entity_code": "default",
      "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"
      },
      "purchase_order_number": "PO-123"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

  • 5d26657495a3Revision changes
    • info

      added the new optional query request parameter metadata[key]

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status