FlowAlp

Retrieve and list Paylinks

July 30, 2026

Retrieve a FlowAlp Pay Paylink by ID with GET /Invoice/{id}/ and verify its payment. curl and PHP SDK examples, response fields, errors.

Read a single Paylink by its ID to inspect its configuration or to verify that a payment notification really belongs to it. In the Merchant API the Paylink resource is called Invoice.

GEThttps://api.pay.flowalp.com/v1.16/Invoice/{id}/v1.14 · v1.15 · v1.16

Use API version v1.16 for new integrations; v1.14 and v1.15 remain supported. Authenticate with the X-API-KEY header — see Authentication.

Request

Path parameters

ParameterTypeRequiredDescription
idintegerYesID of the Paylink (Invoice) to retrieve, as returned by Create a Paylink.

Query parameters

ParameterTypeRequiredDescription
instancestringYesName of your merchant instance; identifies your account on every API call.

Example request

Retrieve a Paylink (cURL)bash
curl --request GET \
  --url "https://api.pay.flowalp.com/v1.16/Invoice/57/?instance=${FLOWALP_PAY_INSTANCE}" \
  --header "X-API-KEY: ${FLOWALP_PAY_API_SECRET}"
Retrieve a Paylink (PHP SDK)PHP
<?php
use FlowAlpPay\FlowAlpPay;
use FlowAlpPay\Models\Request\Paylink;

$client = new FlowAlpPay(
    getenv('FLOWALP_PAY_INSTANCE'),
    getenv('FLOWALP_PAY_API_SECRET'),
    FlowAlpPay::DEFAULT_COMMUNICATION_HANDLER,
    'pay.flowalp.com',
    '1.16'
);

$paylink = new Paylink();
$paylink->setId(57);

$response = $client->getOne($paylink);

$link        = $response->getLink();
$referenceId = $response->getReferenceId();

Response

The Paylink is returned inside the success envelope. A common pattern: when a webhook announces a payment, call this endpoint with the stored ID and compare referenceId and amount with your own records before you mark the invoice as paid.

200 OKJSON
{
  "status": "success",
  "data": [
    {
      "id": 57,
      "hash": "f7d1b2e94c3a48d2a5efb6c17d0a9c31",
      "referenceId": "INV-2026-0042",
      "link": "https://demo-shop.pay.flowalp.com/?payment=f7d1b2e94c3a48d2a5efb6c17d0a9c31",
      "title": "Invoice INV-2026-0042",
      "description": "Consulting services, June 2026",
      "purpose": "Invoice INV-2026-0042",
      "amount": 8925,
      "currency": "CHF",
      "createdAt": "2026-07-30 11:52:08"
    }
  ]
}

List Paylinks

API versions v1.14 to v1.16 do not document a collection query that returns all Paylinks of an instance, and no pagination parameters are available for this resource. Retrieve Paylinks individually by ID, and store the mapping between id, hash and referenceId in your own database at creation time.

If you have lost a Paylink ID or need a bulk export of existing Paylinks, contact support. Do not try to reconstruct IDs by iterating over the numeric range — you would quickly run into the rate limit.

Errors

HTTP statusMeaningRecommended action
404No Paylink with this ID exists on your instance.Check the stored Paylink ID and the instance parameter.

Error responses use the envelope {"status": "error", "message": "..."} — see Errors and Rate limits.

Related: Create a Paylink, Update and delete a Paylink and the product guide Pay links and QR codes.