List payment attempts

GET

/payments

Returns a paginated list of payment attempts for the authenticated user. Supports filtering by status, payment type, date range, and specific IDs.

Authorizations

token

Parameters

Query Parameters

page

integer

default: 1 >= 1

Current page

_order[created_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Sort by timestamp when the entity was created

status

integer

Exact filter by the payment status

type

integer

Exact filter by the payment method type

integer

Exact filter by the payment attempt ID

id[]

Array<integer>

Exact filter by multiple payment attempt IDs

created_at

integer

Exact filter by the creation timestamp

created_at[]

Array<integer>

Exact and range filter by the creation timestamps

Responses

200

Payment collection

object

@context

One of:

string
object

string

@id

JSON-LD ID

string

@type

JSON-LD type

string

member

Array<object>

Payment attempt details (JSON-LD)

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

Payment Attempt ID

integer

created_at

Creation date (unix timestamp)

integer

completed_at

Completion date (unix timestamp), null if not completed

integer | null

status

Payment status: 0 = New, 10 = In Progress (before request), 20 = In Progress (after request), 100 = Done, 200 = Canceled by user, 300 = Canceled by timeout, 400 = Canceled by admin, 1000 = Error

integer

Allowed values: 0 10 20 100 200 300 400 1000

amount

Total payment amount

number

net_val

Net cost value

number

vat_val

VAT value

number

fee_val

Fee value

number

currency

Currency

string

default: EUR

Allowed values: EUR CHF

type

Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card

integer

Allowed values: 1 6 7 8 91 92

invoice

URI to related invoice, null if not yet created

string | null

error

Error message if payment failed, null otherwise

string | null

hydra:totalItems

Total number of items in the collection

integer

hydra:view

Pagination links for navigating the collection

object

@id

string format: iri-reference

@type

string

hydra:first

string format: iri-reference

hydra:last

string format: iri-reference

hydra:previous

string format: iri-reference

hydra:next

string format: iri-reference

hydra:search

Search and filtering template for the collection

object

@type

string

hydra:template

string

hydra:variableRepresentation

string

hydra:mapping

Array<object>

object

@type

string

variable

string

property

string | null

required

boolean

key

additional properties

any

Examples

payments_jsonld

Payment list (JSON-LD)

Example response for GET /payments with Accept: application/ld+json

{
  "@context": "/contexts/PaymentAttempt",
  "@id": "/payments",
  "@type": "Collection",
  "totalItems": 2,
  "member": [
    {
      "@id": "/payments/123",
      "@type": "PaymentAttempt",
      "id": 123,
      "created_at": 1750152600,
      "completed_at": null,
      "status": 20,
      "amount": 121.38,
      "net_val": 100,
      "vat_val": 19.38,
      "fee_val": 2,
      "currency": "EUR",
      "type": 7,
      "invoice": null,
      "error": null
    },
    {
      "@id": "/payments/120",
      "@type": "PaymentAttempt",
      "id": 120,
      "created_at": 1750066200,
      "completed_at": 1750066200,
      "status": 100,
      "amount": 100,
      "net_val": 100,
      "vat_val": 0,
      "fee_val": 0,
      "currency": "EUR",
      "type": 6,
      "invoice": "/invoices/456",
      "error": null
    }
  ],
  "view": {
    "@id": "/payments?page=1",
    "@type": "PartialCollectionView"
  },
  "search": {
    "@type": "IriTemplate",
    "template": "/payments{?page,_order[created_at],status,type,id,id[],created_at,created_at[]}",
    "variableRepresentation": "BasicRepresentation",
    "mapping": [
      {
        "@type": "IriTemplateMapping",
        "variable": "page",
        "property": "page",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "_order[created_at]",
        "property": "created_at",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "status",
        "property": "status",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "type",
        "property": "type",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "id",
        "property": "id",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "id[]",
        "property": "id",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "created_at",
        "property": "created_at",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "created_at[]",
        "property": "created_at",
        "required": false
      }
    ]
  }
}

Array<object>

Payment attempt details

object

Payment Attempt ID

integer

created_at

Creation date (unix timestamp)

integer

completed_at

Completion date (unix timestamp), null if not completed

integer | null

status

Payment status: 0 = New, 10 = In Progress (before request), 20 = In Progress (after request), 100 = Done, 200 = Canceled by user, 300 = Canceled by timeout, 400 = Canceled by admin, 1000 = Error

integer

Allowed values: 0 10 20 100 200 300 400 1000

amount

Total payment amount

number

net_val

Net cost value

number

vat_val

VAT value

number

fee_val

Fee value

number

currency

Currency

string

default: EUR

Allowed values: EUR CHF

type

Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card

integer

Allowed values: 1 6 7 8 91 92

invoice

URI to related invoice, null if not yet created

string | null

error

Error message if payment failed, null otherwise

string | null

paid_with_id

ID of the payment method used (stored card ID or SEPA mandate ID), null if not applicable

Examples

payments_json

Payment list

Example response for GET /payments with Accept: application/json

[
  {
    "id": 123,
    "created_at": 1750152600,
    "completed_at": null,
    "status": 20,
    "amount": 121.38,
    "net_val": 100,
    "vat_val": 19.38,
    "fee_val": 2,
    "currency": "EUR",
    "type": 7,
    "invoice": null,
    "error": null
  },
  {
    "id": 120,
    "created_at": 1750066200,
    "completed_at": 1750066200,
    "status": 100,
    "amount": 100,
    "net_val": 100,
    "vat_val": 0,
    "fee_val": 0,
    "currency": "EUR",
    "type": 6,
    "invoice": "/invoices/456",
    "error": null
  }
]

401

Client ID or API key isn’t active or invalid!

403

Account isn’t activated. Please wait or contact to support!

429

IP address was temporary blocked, because during short time from it was sent many request with invalid credentials. Please wait and try later.

Code Samples

curl -s 'https://api.lox24.eu/payments' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN");

        var response = await client.GetStringAsync("https://api.lox24.eu/payments");
        Console.WriteLine(response);
    }
}

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.lox24.eu/payments", nil)
  req.Header.Set("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN")

  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()
  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.lox24.eu/payments"))
                .header("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN")
                .GET()
                .build();

        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

<?php

$ch = curl_init('https://api.lox24.eu/payments');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;