List payments for a payment link

curl --request GET \
  --url https://thirdparty.qonto.com/v2/payment_links/{id}/payments \
  --header 'Authorization: Bearer <token>'

{
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": {
        "value": "13.30",
        "currency": "EUR"
      },
      "status": "open",
      "created_at": "2021-01-01T00:00:00Z",
      "payment_method": "credit_card",
      "paid_at": "2021-01-01T00:00:00Z",
      "debitor_email": "[email protected]"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 11,
    "total_count": 210,
    "per_page": 20
  }
}

GET

payment_links

{id}

payments

List payments for a payment link

curl --request GET \
  --url https://thirdparty.qonto.com/v2/payment_links/{id}/payments \
  --header 'Authorization: Bearer <token>'

{
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": {
        "value": "13.30",
        "currency": "EUR"
      },
      "status": "open",
      "created_at": "2021-01-01T00:00:00Z",
      "payment_method": "credit_card",
      "paid_at": "2021-01-01T00:00:00Z",
      "debitor_email": "[email protected]"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 11,
    "total_count": 210,
    "per_page": 20
  }
}

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.

Path Parameters

string<uuid>

required

Payment link ID

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,

pending,

authorized,

paid,

canceled,

expired,

failed

Example:

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

sort_by

enum<string>

Sort payments by a field.

Available options:

creation_date:asc,

creation_date:desc

Example:

"?sort_by=creation_date:asc"

Response

The payments have been retrieved successfully.

payments

object[]

required

Show child attributes

payments.id

string<uuid>

required

The ID of the payment.

payments.amount

object

required

Show child attributes

payments.amount.value

string

required

The amount of the payment, formatted as a decimal string.

Example:

"13.30"

payments.amount.currency

string

required

The currency of the payment, formatted as an ISO 4217 currency code.

Example:

"EUR"

payments.status

enum<string>

required

The status of the payment.

Available options:

open,

pending,

authorized,

paid,

canceled,

expired,

failed

Example:

"open"

payments.created_at

string<date-time>

required

The date and time when the payment was created, formatted as an ISO 8601 date-time string.

Example:

"2021-01-01T00:00:00Z"

payments.payment_method

enum<string>

required

The method of payment used for the payment.

Available options:

credit_card,

apple_pay,

paypal,

ideal

Example:

"credit_card"

payments.paid_at

null | string<date-time>

required

The date and time when the payment was paid, formatted as an ISO 8601 date-time string.

Example:

"2021-01-01T00:00:00Z"

payments.debitor_email

string

required

The email address of the debitor.

Example:

"[email protected]"

Business API

Onboarding API

List payments for a payment link

Authorizations

Headers

Path Parameters

Query Parameters

Response