Skip to main content
POST
/
api
/
v1
/
payment-links
Create a new payment link (Partner or Merchant authentication)
curl --request POST \
  --url https://core.quidkey.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'
{
  "success": true,
  "data": {
    "payment_link_url": "https://core.quidkey.com/payment-link/a1b2c3d4e5f6..."
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body

order
object
required
merchant_id
string<uuid>

Required for Partner authentication, forbidden for Merchant authentication

metadata
object

Optional metadata to attach to the payment link

redirect_urls
object

Response

Created

success
boolean
required

Indicates if the request was successful

Example:

true

data
object
required