The wallet transaction object

{
  "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",
  "invoice_requires_successful_payment": false,
  "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'",
  "payment_method": {
    "payment_method_type": "provider",
    "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
  },
  "purchase_order_number": "PO-123",
  "applied_invoice_custom_sections": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2023-07-06T14:35:58Z",
      "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"
      },
      "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
    }
  ]
}

lago_id

string<uuid>

required

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

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_wallet_id

string<uuid>

required

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.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

billing_entity_code

string

required

The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one.

Example:

"default"

lago_invoice_id

string<uuid> | null

required

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

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_credit_note_id

string<uuid> | null

required

Unique identifier of the credit note associated with this wallet transaction. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_voided_invoice_id

string<uuid> | null

required

Unique identifier of the invoice that was voided and triggered the creation of this inbound wallet transaction. Only present for inbound transactions on traceable wallets that were created as a result of an invoice void.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

status

enum<string>

required

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

Available options:

pending,

settled,

failed

Example:

"settled"

source

enum<string>

required

The source field represents the origin or trigger of the wallet transaction. Possible values are manual, interval, threshold

Available options:

manual,

interval,

threshold

Example:

"manual"

transaction_status

enum<string>

required

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

Available options:

purchased,

granted,

voided,

invoiced

Example:

"purchased"

transaction_type

enum<string>

required

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

Available options:

inbound,

outbound

Example:

"inbound"

amount

string

required

The amount of credits based on the rate and the currency.

Pattern: ^[0-9]+.?[0-9]*$

Example:

"10.0"

credit_amount

string

required

The number of credits used in the wallet transaction.

Pattern: ^[0-9]+.?[0-9]*$

Example:

"100.0"

invoice_requires_successful_payment

boolean

required

A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.

Example:

false

metadata

object[]

required

This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.

Show child attributes

Example:

[
  {
    "key": "example key",
    "value": "example value"
  },
  {
    "key": "another key",
    "value": "another value"
  }
]

remaining_amount_cents

integer | null

required

The remaining unconsumed amount of an inbound wallet transaction, expressed in cents. Only present for inbound transactions on traceable wallets. Tracks how much of the original credited amount has not yet been consumed by outbound transactions.

Example:

5000

remaining_credit_amount

string | null

required

The remaining unconsumed amount of an inbound wallet transaction, expressed in credits. Only present for inbound transactions on traceable wallets.

Pattern: ^[0-9]+.?[0-9]*$

Example:

"5.0"

priority

integer

required

The priority of the wallet transaction, used to determine the order in which inbound transactions are consumed. Lower values are consumed first.

Example:

50

settled_at

string<date-time> | null

required

The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"

failed_at

string<date-time> | null

required

The date when the wallet transaction failed, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"

created_at

string<date-time>

required

The date of the wallet transaction creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"

name

string | null

required

The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either Prepaid credits - {{wallet_name}} if the wallet name is set, or Prepaid credits.

Example:

"Tokens for models 'high-fidelity-boost'"

payment_method

object

required

The payment method assigned to this wallet transaction for processing the payment.

Show child attributes

purchase_order_number

string | null

required

The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's purchase_order_number.

Example:

"PO-123"

applied_invoice_custom_sections

object[]

The invoice custom sections applied to invoices generated by this wallet transaction.

Show child attributes