Sign in

v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB
Payment Link

Retrieve payment link details

Retrieve payment link details

get/api/v1/payment-link/{short_id}

Path parameters

short_idstring required

Response

idstring required
product_idstring uuid required

Identifies a product, it can be a Widget or other product type

urlstring required
status'active' | 'expired' | 'cancelled'
expires_atstring date-time nullable

Date the payment link will expire

qr_codestring nullable

Payment link qr code

created_atstring date-time required

Date the payment link was created

emailstring email nullable

Email of the user that created the payment link

reusableboolean

If the payment link can be used multiple times

type'generic'
callback_urlstring url nullable

URL to be called when the payment link status changes

return_urlstring url nullable

URL to redirect the user after the payment link is paid