Payment Links

Create a payment link

Creates a payment link and returns its id and shareable checkout url — send the payer to that URL.

The link settles to the authenticated user's default wallet, in that wallet's chain and token; toAmount is denominated in that token. The destination cannot be specified by the caller. Links created from the Moove dashboard may instead settle to another of the owner's wallets (toWalletAddress).

A link's type is crypto or fiat. A crypto link requests toAmount of the settlement token. A fiat link is fixed in fiatAmount + fiatCurrency, paid by card, single-use, and still settles in the settlement token; it is returned with toAmount: null. The currency must be one card checkout is offered in, and the settlement token one the card provider delivers. A crypto link is paid from a crypto wallet only.

Requires the payment_link:create scope.

post/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

Request body

type'crypto' | 'fiat' nullable

crypto to request toAmount of the settlement token, fiat to request fiatAmount in fiatCurrency, paid by card. Inferred from the amount given when omitted.

fiatCurrencystring nullable

ISO 4217 code for fiatAmount. Must be a currency card checkout is offered in (paymentLinkCurrencies on GET /v1/settings/payment).

descriptionstring nullable

Shown to the payer on the checkout page.

toWalletAddressstring nullable

One of your wallets to settle to, in that wallet's token. Settles to your default wallet when omitted. Dashboard sessions only.

maxUsageinteger nullable

How many payments the link accepts before it completes. Unlimited when omitted.

expirationDatestring date-time nullable

ISO 8601 timestamp, in the future. After it passes the link stops accepting payments. Never expires when omitted.

Response

Successful Response

idstring required
urlstring required

Changes

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