General APIs with JWT

Get the user's transactions

Changed on

Every payment, credit and refund row of the authenticated user, with is_deposit and is_first_deposit computed per row.

get/transactions

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/transactions
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Transactions retrieved successfully

idstring uuid required
user_idstring uuid nullable
customer_idstring nullable
platform'COINBASE' | 'STRIPE' | 'TAO' | 'ALPHA' | 'REFERRAL' | 'ADMIN' | 'NOWPAYMENTS' | 'TMC_PAY'
status'PENDING' | 'COMPLETED' | 'FAILED'
descriptionstring nullable
amountnumber nullable
currencystring nullable
amount_in_usdnumber nullable
reference_idstring required
stripe_invoice_idstring nullable
tmc_pay_invoice_idstring nullable
transaction_created_atstring date-time required
transaction_paid_atstring date-time nullable
failure_reasonstring nullable

Why a FAILED payment failed, as <code>: <provider message>. Codes: invoice_rejected (TMC Pay refused to create the invoice; HTTP status and its message), invoice_expired / invoice_cancelled (TMC Pay closed the invoice unpaid; names any crypto received but not credited), card_declined (Stripe auto top-up; decline code and the bank's message). Null on rows failed before this field existed and on non-failed rows.

failed_atstring date-time nullable

When the payment was marked FAILED (UTC).

api_key_idstring uuid nullable

The API key that started this payment; null for a browser session.

api_key_namestring nullable

That key's name at the time of the payment.

is_depositboolean required

True when the renter paid this money in (card, crypto, TAO, alpha) and the payment is COMPLETED with a positive amount. False for pending or failed rows, bonus rows, disputes, payouts, referral and admin credits.

is_first_depositboolean required

True on exactly one row: the earliest deposit (by paid time) this user ever completed.

Changes

  • b37fb58fd012Revision changes
    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f380a826774dRevision changes
    • breaking

      the response property / became optional for the status

    • breaking

      response property items/user_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response property's maxLength was unset from 255 for the response status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status