Skip to main content
POST
Create a payment link
Create one link per purchase and send the payer to https://pay.staging.paywire.xyz/pay/{id}. See Create a payment link for the full walkthrough.

Authorizations

Authorization
string
header
required

Your gateway's API key (w3g_...).

Body

application/json
amount
number
required

Price in currency.

allowedAssets
object[]
required

Coins the payer may pay with.

Minimum array length: 1
callbackUrl
string<uri>
required

Absolute https URL for webhooks.

currency
string
default:USD
returnUrl
string<uri> | null

Absolute https URL offered to the payer after paying.

orderTtlMinutes
integer | null

How long a quote holds. Default 30.

Required range: 5 <= x <= 1440
policyOverride
object | null

This link's own payment policy, replacing the company's.

Response

The payment link.

id
string<uuid>
merchantId
string<uuid>
amount
number
currency
string
allowedAssets
object[]
callbackUrl
string<uri>
orderTtlMinutes
integer
policyOverride
object | null

This link's own payment policy, replacing the company's.

returnUrl
string<uri> | null
isActive
boolean
createdAt
string<date-time>