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

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

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

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

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

Jun 16, 2026b372e7d5563d118See the full diff
- ▲
  the data response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ○
  removed paymentLink_ListItem subschema #2 from the data response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  added the required property data/amount to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/currency to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/expires_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/first_viewed_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/link_type to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/locale to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/merchant to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/metadata to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/order_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/payment_link_url to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/payment_reference to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/redirect_urls to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/status to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/transaction_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/views_count to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 28, 2026ecd256fe01061See the full diff
- ○
  endpoint added
  endpoint-added
Nov 2, 2025919eb7a392aa1See 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

Full history