Sign in

v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB
Payment Link

Download payment links as CSV

Download payment links as CSV

post/api/v1/payment-link/download

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

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'
amountstring decimal nullable

Amount to be charged to a payment intent

currencyinteger nullable

Currency associated with the amount of the payment link

conceptstring nullable

Concept associated with the payment link. This text will be reflected as a concept in the bank issuing the payment

external_idstring nullable

An external ID to identify a user. It can be the merchant's user ID or other tracking ID

created_atstring date-time required

Date the payment link was created

expires_atstring date-time nullable

Date the payment link will expire

emailstring email nullable

Email of the user that created the payment link

reusableboolean

If the payment link can be used multiple times

paidboolean

If the payment link has been paid