Skip to main content
GET
/
v1
/
payments
/
{id}
Retrieve a payment
curl --request GET \
  --url https://api.flowlix.dev/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E",
  "amount": 4999,
  "currency": "EUR",
  "status": "SUCCEEDED",
  "integration_type": "DIRECT",
  "amount_refunded": 0,
  "amount_refundable": 4999,
  "created_at": 1719792000,
  "livemode": false,
  "merchant_reference": "ord_1234",
  "description": "Order #1234",
  "card": {
    "brand": "visa",
    "last4": "1111",
    "exp_month": 12,
    "exp_year": 2027,
    "country": "DE"
  },
  "billing_details": {
    "email": "jenny@example.com",
    "first_name": "Jenny",
    "last_name": "Rosen",
    "phone": "+491701234567",
    "address": {
      "line1": "Kurfuerstendamm 21",
      "line2": "Apartment 4B",
      "city": "Berlin",
      "state": "Berlin",
      "postal_code": "10719",
      "country": "DE"
    }
  },
  "metadata": {
    "order_id": "ord_1234"
  },
  "decline_code": "insufficient_funds",
  "decline_message": "The card has insufficient funds.",
  "hosted_payment_url": "https://pay.flowlix.dev/hpp/pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E",
  "refunds": [],
  "status_transitions": {
    "requires_action_at": null,
    "processing_at": 1719792002,
    "succeeded_at": 1719792042,
    "failed_at": null,
    "canceled_at": null,
    "expired_at": null
  },
  "next_action": {
    "redirect_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use your secret API key as the Bearer token. Test mode keys start with api_test_sk_ and live mode keys start with api_live_sk_. Both modes use the same API host; the mode is determined by the key.

Authorization: Bearer api_test_sk_abc123def456

Path Parameters

​
id
string
required

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

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

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

Response

The current Payment object. Use status, next_action, decline_code, amount_refundable, and refunds to decide the next merchant-side action.

A Payment represents one attempt to collect funds from the customer. Merchants can use merchant_reference to associate multiple payment attempts with the same order or checkout in their own systems.

​
id
string
required

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

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

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
amount
integer<int64>
required

Payment amount in minor units.

Required range: x >= 1
Example:

4999

​
currency
enum<string>
required

Three-letter ISO 4217 currency code. Currently supported for card acquiring: EUR.

Available options:
EUR
Example:

"EUR"

​
status
enum<string>
required

Current status of a payment attempt.

  • PENDING -- The payment was accepted by Flowlix and is waiting to be processed.
  • REQUIRES_ACTION -- Customer action is required, usually 3D Secure authentication.
  • PROCESSING -- The payment is being processed by downstream payment systems.
  • SUCCEEDED -- The payment completed successfully.
  • FAILED -- The payment was declined or failed permanently.
  • CANCELED -- The payment was canceled before completion.
  • EXPIRED -- The customer did not complete a required action before its expiry time.
Available options:
PENDING,
REQUIRES_ACTION,
PROCESSING,
SUCCEEDED,
FAILED,
CANCELED,
EXPIRED
Example:

"SUCCEEDED"

​
integration_type
enum<string>
required

How the payment was collected. This is separate from the payment method instrument, such as card or a future wallet.

Available options:
DIRECT,
HOSTED_PAYMENT_PAGE
Example:

"DIRECT"

​
amount_refunded
integer<int64>
required

Total amount successfully refunded so far, in minor units.

Required range: x >= 0
Example:

0

​
amount_refundable
integer<int64>
required

Remaining amount that can be refunded, in minor units.

Required range: x >= 0
Example:

4999

​
created_at
integer<int64>
required

Unix timestamp when the payment was created.

Example:

1719792000

​
livemode
boolean
required

Whether this payment was created using a live API key.

Example:

false

​
merchant_reference
string | null

Merchant-side order or checkout reference for reconciliation, if provided. This field does not provide idempotency by itself.

Maximum string length: 255
Example:

"ord_1234"

​
description
string | null

Merchant-provided payment description.

Example:

"Order #1234"

​
card
object

Masked card details, or null before card details are available.

​
billing_details
object

Billing details captured for the payment, if available.

​
metadata
object

Merchant-provided metadata. Values may be any valid JSON value.

Example:
{ "order_id": "ord_1234" }
​
decline_code
string | null

Machine-readable decline code when the payment fails.

Example:

"insufficient_funds"

​
decline_message
string | null

Human-readable decline explanation when available.

Example:

"The card has insufficient funds."

​
hosted_payment_url
string<uri> | null

URL of the hosted payment page for HPP payments.

Example:

"https://pay.flowlix.dev/hpp/pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
refunds
object[]

Refunds created for this payment, oldest first.

​
status_transitions
object

Timestamps for important payment status transitions.

​
next_action
object

Customer action required to continue the payment.