FlowAlp

Retrieve a Gateway

July 30, 2026

Retrieve a FlowAlp Pay Gateway by ID to check its payment status (waiting, confirmed, authorized, reserved). curl and PHP SDK examples.

Retrieve a Gateway reads the current state of a single Gateway by its ID. Use it to check whether a checkout has been paid — for example to double-check a webhook you received — or to look up the payment link and configuration again.

GEThttps://api.pay.flowalp.com/v1.16/Gateway/{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 Gateway to retrieve, as returned when the Gateway was created.

Query parameters

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

Example request

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

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

$gateway = new Gateway();
$gateway->setId(42);

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

// waiting, confirmed, authorized or reserved
$status = $response->getStatus();

Response

The Gateway is returned inside the standard success envelope. The status field tells you where the payment stands.

200 OKJSON
{
  "status": "success",
  "data": [
    {
      "id": 42,
      "status": "confirmed",
      "hash": "cb1a4e6ad0714b8c93cbfe6a6e2489d5",
      "referenceId": "ORDER-2026-001",
      "link": "https://demo-shop.pay.flowalp.com/?payment=cb1a4e6ad0714b8c93cbfe6a6e2489d5",
      "amount": 8925,
      "currency": "CHF",
      "preAuthorization": false,
      "reservation": false,
      "createdAt": "2026-07-30 11:52:08"
    }
  ]
}

Payment status values

ValueMeaningTypical next step
waitingNo completed payment yet; the customer has not (successfully) finished the checkout.Keep waiting or let the Gateway expire; confirmation arrives by webhook.
confirmedThe payment was completed and the amount has been charged.Fulfil the order and reconcile it using referenceId.
authorizedThe payment method was successfully authorized or stored, but no amount has been charged yet.Charge the stored payment method later via the Transactions API.
reservedThe amount is reserved on the customer's payment method.Capture the reservation to collect the money.

Prefer webhooks over polling this endpoint: FlowAlp Pay notifies your server as soon as the payment state changes, and you can then call Retrieve a Gateway to verify the notification against the API before you update the order. To charge or capture authorized and reserved payments, use the Transactions API.

Errors

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

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

Related: create checkouts with Create a Gateway, remove unused ones with Delete a Gateway, and set up notifications in Configure webhooks.