Skip to main content
GET
List payment links

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

page
integer
default:1

Page number for pagination. Must be greater than 0.

Required range: x >= 1
per_page
integer
default:100

Number of records per page. Must be between 1 and 100.

Required range: 1 <= x <= 100
status
enum<string>[]

Filter payments by status.

Available options:
open,
expired,
canceled,
paid,
processing
Example:

"?status[]=open&status[]=paid"

sort_by
enum<string>

Sort payments by a field.

Available options:
amount:asc,
amount:desc,
expiration_date:asc,
expiration_date:desc
Example:

"?sort_by=amount:asc"

Response

The payment links have been retrieved successfully.

meta
object
required

Metadata for paginated responses