Skip to main content
GET
List all collecting documents

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

virtual_account_id
string<uuid>
required

Virtual account ID Unique identifier

from_datetime
string<date-time>
required

From datetime Datetime schema

to_datetime
string<date-time>
required

To datetime Datetime schema

reconciliation_id
string<uuid>

Reconciliation ID Unique identifier

ref_type
string

Collecting document ref type

status
enum<string>

Collecting document status

Available options:
created,
confirmed,
settled,
refunded,
reversed,
failed
type
string

Collecting document type

before
string

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

after
string

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Response

Documents

List of collecting documents

data
Collecting document · object[]