---
title: "Get payment link orders"
method: GET
path: "/paymentlink/orders"
tags: ["Payment Link"]
---

# Get payment link orders

`GET /paymentlink/orders`

Retrieve orders associated with a payment link. Useful for getting the order ID for payment simulation in staging.

## Query parameters

- `id` string, uuid, required

## Response `200`

Payment link order details

- object
  - `status` string
  - `message` string
  - `data` PaymentLinkOrderDetails — Complete payment link details including associated orders
    - `id` string, uuid — Payment link ID
    - `name` string — Name of the payment link
    - `description` string — Description of the payment
    - `type` 'ONE_TIME' | 'RECURRING' — Type of payment link
    - `amount` string — Amount in lowest denomination of the payment currency
    - `fee` string, nullable — Fee amount if applicable
    - `addFeeToTotalCost` boolean — Whether fees are added to total cost
    - `settlementCurrency` string — Currency for settlement
    - `settlementMethod` 'ONCHAIN' | 'LIGHTNING' — Settlement method
    - `speed` 'slow' | 'medium' | 'fast' — Network fee priority for on-chain transactions
    - `paymentCurrency` string — Currency the user pays in
    - `paymentMethods` string[] — Accepted payment methods
    - `callbackUrl` string, uri — Redirect URL where users are sent after payment completion
    - `channel` string — Channel through which payment link was created
    - `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED' — Payment link status
    - `accountId` string, uuid — Account ID of the payment link owner
    - `expiresAt` string, date-time, nullable — Expiration time of the payment link
    - `invoice` string, nullable — Lightning invoice if applicable
    - `companyLogo` string, nullable — Company logo URL
    - `beneficiaryId` string — Beneficiary identifier (Bitcoin address or Lightning address)
    - `createdAt` string, date-time — Payment link creation time
    - `updatedAt` string, date-time — Payment link last update time
    - `orders` PaymentLinkOrder[] — List of orders associated with this payment link. A new order is created when a previous order expires.
      - `id` string, uuid — Unique order identifier
      - `status` 'PENDING' | 'PAID' | 'EXPIRED' | 'FAILED' — Order status
      - `orderId` string — Order ID for tracking and simulation
      - `paymentLinkId` string, uuid — Associated payment link ID
      - `paymentMethod` string — Payment method used
      - `createdAt` string, date-time — Order creation time
      - `updatedAt` string, date-time — Order last update time

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/stealthmoney/apis/mavapay-api.md) · [All operations](https://skmtc.net/stealthmoney/apis/mavapay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stealthmoney/mavapay-api/revisions/94cb0ddffad0/schema)