Payment Links

List payment links

Returns the payment links belonging to the authenticated user, newest first, 10 per page by default. Use offset to page, limit to change the page size (max 100), status to filter, date_from/date_to to bound the creation date (ISO 8601; date_from inclusive, date_to exclusive; a value without a UTC offset is read as UTC), and q to search by link ID, description or amount (a case-insensitive substring match, at most 100 characters).

total on the response is the number of links matching the filters, ignoring offset/limit; it is null on an empty page requested past the end. It is an upper bound: a link whose token is no longer supported is counted but not returned.

A key sees every link its owner can see, including links created from the dashboard or by a sibling key — so this is the endpoint to reconcile against.

Requires the payment_link:read scope.

get/v1/payment-link

Request

  • Base URL: https://api.moove.xyz
  • URL: https://api.moove.xyz/v1/payment-link
  • Auth: API key in header X-API-Key

Query parameters

status'active' | 'inactive' | 'completed' nullable
offsetinteger
limitinteger
qstring nullable
date_fromstring date-time nullable
date_tostring date-time nullable

Response

Successful Response

limitinteger required
offsetinteger required
nextOffsetinteger nullable
totalinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.