Skip to main content
GET
List payment links

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

sort
enum<string>

The order to sort the results

Available options:
asc,
desc
Example:

"asc"

limit
integer

The number of items to return

Example:

10

cursor
string<string>

The cursor

q
string

Search query for payment links

status
enum<string>[]
Available options:
draft,
pending,
active,
expired,
deleted,
paid
type
enum<string>[]

Filter by type (payment_link or invoice)

Available options:
payment_link,
invoice

Response

Successful response

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

pagination
object
required
data
object[]
required