Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Payment Links

Create a new payment link (Partner or Merchant authentication)

Create a new payment link (Partner or Merchant authentication)

post/api/v1/payment-links

Request body

merchant_idstring uuid

Required for Partner authentication, forbidden for Merchant authentication

metadataobject

Optional metadata to attach to the payment link

Example request

{
  "order": {
    "amount": 1000,
    "currency": "GBP",
    "payment_reference": "Invoice #123",
    "order_id": "ORD-123456",
    "locale": "en",
    "test_transaction": true
  },
  "redirect_urls": {
    "success_url": "https://example.com/payment/success",
    "failure_url": "https://example.com/payment/failure"
  }
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "payment_link_url": "https://core.quidkey.com/payment-link/a1b2c3d4e5f6..."
  }
}