Skip to main content
Full reference for all configuration options when creating and managing PIK Payment Links via the Dashboard or API.”
This page covers every configuration option available when creating a PIK Payment Link, including required fields, optional settings, and how each setting affects the payer experience and settlement.

​
Required fields

amount_type — Set to fixed if you want the payer to send a specific amount, or open if the payer enters their own amount. Fixed is recommended for invoicing and order collection. Open is suited to donations and flexible billing. currency — The currency the payer must send. Supported values are USDT and AUD. You cannot mix currencies in a single payment link. reference — A string you define to identify this payment in your records. The reference is displayed to the payer as the transfer reference they must use. Keep it short, unique, and without spaces — for example INV-2025-001 or ORDER-8842.

​
Optional fields

amount — Required when amount_type is fixed. The exact amount the payer must send, as a decimal string — for example 150.00. Do not include currency symbols. expiry — A datetime in ISO 8601 format specifying when the link expires. After expiry the link deactivates and no new payments are accepted. If omitted, the link does not expire. single_use — Boolean. Set to true for single-use links that deactivate after one successful payment. Set to false for reusable links. Defaults to false. merchant_name — Your business name as it will appear on the payment page. If not set, your PIK account name is used. merchant_logo_url — A URL to your logo image. Displayed on the payment page for branding. Recommended size is 200x200 pixels in PNG or SVG format. redirect_url — A URL the payer is redirected to after a successful payment. Use this to send customers back to your website or confirmation page. webhook_url — A URL where PIK will POST a payment.settled event when the payment is completed. This overrides your account-level webhook setting for this specific link. metadata — A key-value object for attaching your own internal data to the payment link — for example your internal order ID or customer ID. Metadata is returned in API responses and webhook payloads but is not visible to the payer. Once created, PIK returns two shareable assets: payment_url — The full URL to the payment page. Share this via email, SMS, invoice, or any channel. qr_code_url — A URL to a QR code image that encodes the payment URL. Download and embed in invoices, print materials, or display on screen.

​
Editing and cancelling

Payment Links cannot be edited after creation. If you need to change any configuration, cancel the existing link and create a new one. To cancel a link, call DELETE /api/v1/payment-links/payment_link_id or click Cancel in the PIK Dashboard under Payments > Payment Links.