Account Information10

Admin13

Agreement2

Auth4

Bank Predictions1

Banks9

Branding14

Command Palette2

Countries3

CrossBorder5

Customer Bank Accounts4

Customers3

Dashboard1

Default Rates3

Embedded8

Evidence1

Go Live2

Invoice10

Legal1

Legal Entities11

Merchant Bank Account Payment Schemes1

Merchant Bank Accounts6

Merchant Documents2

Merchant Invitations4

Merchant Rates3

Merchants16

Onboarding3

Partner Invitations4

Partners6

Payment1

Payment Links6

get/api/v1/payment-linksList payment links with context-aware access control
post/api/v1/payment-linksCreate a new payment link (Partner or Merchant authentication)
get/api/v1/payment-links/receivable-currenciesGet currencies the merchant can receive payments in
get/api/v1/payment-links/{id}Get payment link details by ID
get/api/v1/payment-links/{token}/detailsGet payment link details (public endpoint). Uses secure token for lookup.
post/api/v1/payment-links/{token}/confirmConfirm payment link and create payment request (public endpoint). Uses secure token for lookup.

Payment Schemes1

Payments8

Payout6

Post-Processor Logs2

Provider Configuration4

Refund Resolution Links4

Refunds1

Seeds2

Shareholder Documents2

Shareholder Invitations7

Shopify Orders3

Transaction Updates (Token)3

Transactions14

User Invitations2

Users10

Webhook3

Webhooks5

Payment Links

Get payment link details by ID

Changed on Jun 17, 2026

get/api/v1/payment-links/{id}

Request

Base URL
https://core.quidkey.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/payment-links/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Payment link ID

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "redirect_urls": {
      "success_url": "https://example.com/payment/success",
      "failure_url": "https://example.com/payment/failure"
    }
  }
}

Changes

Jun 17, 2026b372e7d5563d Revision changes
- breaking
  the response's property type changed from no type to object for status
- info
  removed subschema #2 from the response property allOf list for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Feb 28, 2026ecd256fe0106 Revision changes
- info
  endpoint added

Operation history (3 revisions)

Get payment link details by ID

Request

Path parameters

Response 200OK

Example response

Changes

Response