Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: createdAt, scheduledFor, succeededAt, amount. Default -createdAt. The server appends id as a tie-breaker.

Example:

"-createdAt"

filter[invoiceId]
integer

Invoice id (equals).

Required range: x >= 0
filter[invoiceId][in]
string

Invoice id (one of (comma-separated)). Comma-separated values.

filter[method]
enum<string>

Method (equals).

Available options:
sepa-debit,
bank-transfer,
manual
filter[method][in]
string

Method (one of (comma-separated)). Comma-separated values.

filter[status]
enum<string>

Status (equals).

Available options:
scheduled,
awaiting-funds,
initiating,
processing,
succeeded,
failed,
cancelled,
disputed,
dispute-lost
filter[status][in]
string

Status (one of (comma-separated)). Comma-separated values.

filter[failureClass]
enum<string>

Failure class (equals).

Available options:
soft,
hard,
dispute
filter[failureClass][in]
string

Failure class (one of (comma-separated)). Comma-separated values.

filter[createdAt][gt]
string<date-time>

Creation time (download key) (greater than).

filter[createdAt][gte]
string<date-time>

Creation time (download key) (greater than or equal).

filter[createdAt][lt]
string<date-time>

Creation time (download key) (less than).

filter[createdAt][lte]
string<date-time>

Creation time (download key) (less than or equal).

Response

OK

Page envelope of Payment items.

data
object
required

The page.