List payments

curl --request GET \
  --url https://api.flowlix.eu/v1/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.flowlix.eu/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flowlix.eu/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.flowlix.eu/v1/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.flowlix.eu/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "pay_t0Np5Qs1Yu7Aw9Bc2De6Fg8H",
      "amount": 4999,
      "currency": "EUR",
      "status": "SUCCEEDED",
      "integration_type": "DIRECT",
      "merchant_reference": 1234567890,
      "amount_refunded": 0,
      "amount_refundable": 4999,
      "refunds": [],
      "created_at": 1719792000,
      "livemode": false
    }
  ],
  "has_more": false
}

GET

payments

List payments

curl --request GET \
  --url https://api.flowlix.eu/v1/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.flowlix.eu/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flowlix.eu/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.flowlix.eu/v1/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.flowlix.eu/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "pay_t0Np5Qs1Yu7Aw9Bc2De6Fg8H",
      "amount": 4999,
      "currency": "EUR",
      "status": "SUCCEEDED",
      "integration_type": "DIRECT",
      "merchant_reference": 1234567890,
      "amount_refunded": 0,
      "amount_refundable": 4999,
      "refunds": [],
      "created_at": 1719792000,
      "livemode": false
    }
  ],
  "has_more": false
}

Authorizations

Authorization

string

header

required

Use the secret API key for the intended merchant and mode as the Bearer token. Sandbox keys start with api_test_sk_. Send the key only from your server environment.

Authorization: Bearer api_test_sk_abc123def456

Query Parameters

limit

integer

default:10

Maximum number of payments to return. Accepts values between 1 and 100.

Required range: 1 <= x <= 100

starting_after

string

Cursor for forward pagination. Provide the id of the last payment in the previous page. Mutually exclusive with ending_before.

Unique opaque identifier for a payment (pay_ prefix + random alphanumeric suffix).

Pattern: ^pay_[A-Za-z0-9]{24}$

Example:

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

ending_before

string

Cursor for backward pagination. Provide the id of the first payment in the current page. Mutually exclusive with starting_after.

Unique opaque identifier for a payment (pay_ prefix + random alphanumeric suffix).

Pattern: ^pay_[A-Za-z0-9]{24}$

Example:

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

status

enum<string>

Filter payments by status. FAILED also includes payments whose status is EXPIRED. Each returned Payment's status remains authoritative.

Current status of a payment attempt.

PENDING -- The payment was accepted by Flowlix and is awaiting provider submission or the next lifecycle decision.
REQUIRES_ACTION -- Customer action is required, such as completing 3D Secure authentication or a hosted payment page.
PROCESSING -- The payment is being processed by downstream payment systems.
SUCCEEDED -- The payment completed successfully.
FAILED -- The payment was declined or failed permanently.
EXPIRED -- The customer did not complete a required action before its expiry time.

Available options:

PENDING,

REQUIRES_ACTION,

PROCESSING,

SUCCEEDED,

FAILED,

EXPIRED

Example:

"SUCCEEDED"

created_gte

integer<int64>

Return payments created on or after this Unix timestamp in seconds.

created_lt

integer<int64>

Return payments created before this Unix timestamp in seconds.

Response

Matching payments, sorted newest first. An empty data array means no payments match the supplied filters.

Paginated list of payments.

data

object[]

required

Show child attributes

has_more

boolean

required

Whether more payments are available after this page.

Example:

false

⌘I

Get started

Build with Flowlix

Handle failures

API reference

List payments

Authorizations

Query Parameters

Response