Sign in
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..."
  }
}

Changes

Changed in 3 of the 8 revisions of this API.526

  • b372e7d5563d425See the full diff
    • ▲

      the order/currency request property's minLength was increased from 0 to 3

      request-property-min-length-increased

    • ▲

      added the pattern ^[A-Za-z]{3}$ to the request property order/currency

      request-property-pattern-added

    • ▲

      added the pattern property ^(.*)$ to the metadata request property

      request-property-pattern-property-added

    • ▲

      the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • ●

      the order/currency request property's maxLength was set to 3

      request-property-max-length-set

    • ●

      removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added the new optional request property order/test_transaction

      new-optional-request-property

    • ○

      added the new optional request property redirect_urls

      new-optional-request-property

    • ○

      the locale request property default value en was added

      request-property-default-value-added

    • ○

      added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • ○

      added subschema #1 subschema #2 to the error/code response property allOf list for the response status 400

      response-property-all-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecd256fe01061See the full diff
    • ○

      endpoint added

      endpoint-added

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog