Sign in

v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB
Payment Link

List payment links by widget ID

List payment links by widget ID

post/api/v1/payment-link/list

Query parameters

amountstring decimal

Amount equal to

amount__gtstring decimal

Amount greater than

amount__gtestring decimal

Amount greater than or equal to

amount__ltstring decimal

Amount less than

amount__ltestring decimal

Amount less than or equal to

amount__rangeAmount[]

Amount in range

created_atstring date-time

Created at equal to

created_at__gtstring date-time

Created at greater than

created_at__gtestring date-time

Created at greater than or equal to

created_at__ltstring date-time

Created at less than

created_at__ltestring date-time

Created at less than or equal to

created_at__rangestring[]

Created at in range

orderingstring

Order by

pageinteger

Page

paidboolean

If the payment link has been paid or not

searchstring

Free text search in concept or external ID fields

status'active' | 'expired' | 'cancelled'

Status of the payment link

status__inStatus543Enum[]

List Payment Status of the payment link

Request body

widget_idsstring[] required

Response

idstring required
product_idstring uuid required
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

intentsstring[] required
paidboolean

If the payment link has been paid

callback_urlstring url nullable

URL to be called when the payment link status changes - (SOON)

redirect_urlstring url nullable

URL to redirect the user after the payment link is paid - (SOON)