Skip to content
NIXPAYdocs

Payment links

Create a payment link and receive a hosted checkout URL.

POST /v1/payment-links

Request

code
curl -X POST https://api.nixpay.nl/v1/payment-links \
  -H "Authorization: Bearer nixp_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": "49.95", "currency": "EUR" },
    "description": "Order #1234",
    "redirect_url": "https://your-shop.example/thanks",
    "webhook_url": "https://your-shop.example/webhooks/nixpay",
    "metadata": { "order_ref": "1234" }
  }'

| Field | Type | Required | Notes | |---|---|---|---| | amount.value | string | yes | Decimal string, e.g. "49.95" | | amount.currency | string | yes | ISO 4217, e.g. "EUR" | | description | string | no | Shown to the buyer | | redirect_url | string | no | Where the buyer returns after paying | | webhook_url | string | no | Where we POST status events (see Webhooks) | | metadata | object | no | String key/values echoed back to you |

Response 201

code
{
  "id": "pl_9fA...",
  "checkout_url": "https://checkout.nixpay.nl/pl_9fA...",
  "status": "open",
  "amount": { "value": "49.95", "currency": "EUR" }
}

The checkout URL

checkout_url is a NIXPAY-branded interstitial at checkout.nixpay.nl that forwards the buyer to the PSP-hosted checkout. No card data is entered on a NIXPAY domain — send your buyer to this URL.

Redirect the customer to checkout_url. When the payment completes, we send a signed webhook to your webhook_url (see Webhooks).