Payment Link Configuration - PIK Documentation

This page covers every field available when creating a PIK Payment Link. Use the Dashboard for a no-code setup, or the API for programmatic creation.

Required Fields

Field	Type	Values / Format	Description
amount_type	string	fixed or open	fixed: you set the amount. open: payer enters their own amount
currency	string	USDT or AUD	The currency the payer must send. USDC is not available via Payment Link
reference	string	Any string, e.g. INV-2025-001	Identifies the payment in your records and appears on the payer’s page

Optional Fields

Field	Type	Default	Description
amount	decimal string	—	Required when amount_type is fixed. E.g. “150.00” — no currency symbols
expiry	ISO 8601 datetime	No expiry	Link deactivates after this time
single_use	boolean	false	true = deactivates after one successful payment
merchant_name	string	PIK account name	Your business name on the payment page
merchant_logo_url	URL	—	Logo shown on payment page. Recommended: 200×200px PNG or SVG
redirect_url	URL	—	Where the payer is sent after successful payment
webhook_url	URL	—	PIK POSTs a payment.settled event here when funds settle. Overrides account-level webhook for this link
metadata	object	—	Key-value pairs for your own internal data. Returned in API responses and webhooks but not shown to the payer

Currency Note

Payment Links support USDT and AUD only.

Currency	Payment Link	Direct API Payment
AUD	Yes	Yes
USDT	Yes	Yes
USDC	No — use direct API payment or USDT instead	Yes
USD	No	No (wallet currency only)

Important Network Note for Crypto Links

When a Payment Link is created in USDT, PIK displays a wallet address to the payer. The payer must transfer to the mentioned network. After creation, PIK returns two shareable assets:

payment_url — The full URL to the payment page
qr_code_url — A URL to a QR code image encoding the payment URL

Editing and Cancelling

Payment Links cannot be edited after creation. To cancel:

DELETE /api/v1/payment-links/{payment_link_id}

Or cancel from the PIK Dashboard under Payments > Payment Links.

​Required Fields

​Optional Fields

​Currency Note

​Important Network Note for Crypto Links

​Sharing a Payment Link

​Editing and Cancelling

Required Fields

Optional Fields

Currency Note

Important Network Note for Crypto Links

Sharing a Payment Link

Editing and Cancelling