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

# Get payment link details

`GET /paymentlink/details`

Retrieve details about a payment link for rendering a custom UI or checking payment status.

## Query parameters

- `id` string, uuid, required

## Response `200`

Payment link details

- object
  - `status` string
  - `message` string
  - `data` PaymentLinkDetails
    - `paymentLinkDetails` object
      - `id` string, uuid — Payment link ID
      - `name` string — Name of the payment link
      - `description` string — Description of the payment
      - `callbackUrl` string, uri — Redirect URL where users are sent after payment completion
      - `settlementCurrency` string — Settlement currency
      - `paymentLinkOrderId` string, uuid — Associated order ID
      - `paymentMethods` string[]
      - `account` object
        - `name` string — Business name
        - `logo` string — Business logo URL
      - `BANKTRANSFER` object — Bank transfer payment details
        - `ngnAccountName` string — Account name for bank transfer
        - `ngnBankName` string — Bank name
        - `ngnBankAccountNumber` string — Bank account number
        - `amount` number — Amount in lowest denomination
        - `expiresAt` string, date-time — Expiration time for the payment
        - `targetAmount` number — Target amount in the settlement currency (lowest denomination)

## Other responses

- `400` — Bad request
- `404` — Payment link not found

---

[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)
