For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Client Operations

Retrieves a paginated list of client financial operations (transactions) with comprehensive filtering options. Includes detailed information about sources, destinations, amounts, and operation status.

Endpoint

GET/v2/billing/operation

Link

Request

Query Parameters

Parameter
Type
Description & Values
Required
Example

account

string

Filter by account ID or number.

No

"acc_12345"

clientCuid

string

Filter by client customer ID.

No

"cust_67890"

clientName

string

Filter by client name (partial match).

No

"John"

counterpartySuid

string

Filter by counterparty SUID.

No

"suid_abc123"

destination

string

Filter by destination account.

No

"dest_account"

fromCreatedAt

string

Filter operations created after this date (ISO 8601).

No

"2024-01-01T00:00:00Z"

fromUpdatedAt

string

Filter operations updated after this date (ISO 8601).

No

"2024-05-01T00:00:00Z"

meta.page

integer

Page number (starts from 0).

No

0

meta.pageSize

integer

Items per page.

No

20

opid

string

Filter by specific operation ID.

No

"op_12345"

recipientId

string

Filter by recipient ID.

No

"rec_67890"

recipientName

string

Filter by recipient name.

No

"Jane Smith"

senderId

string

Filter by sender ID.

No

"send_12345"

senderName

string

Filter by sender name.

No

"John Doe"

source

string

Filter by source account.

No

"src_account"

status

string

Filter by operation status: - NEW: Created by user/moderator - PENDING: Moderator approved - WORKING: Processing by network - SUCCESS: Completed - FAIL: Failed - CANCELED: Canceled

No

"SUCCESS"

toCreatedAt

string

Filter operations created before this date (ISO 8601).

No

"2024-12-31T23:59:59Z"

toUpdatedAt

string

Filter operations updated before this date (ISO 8601).

No

"2024-05-21T23:59:59Z"

type

string

Filter by operation type: - NOTSET - DEPOSIT - TRANSFER - WITHDRAW - COMMISSION - EXCHANGE - CORRECTING

No

"TRANSFER"

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns a paginated list of operations with detailed information.

Response Fields

1. Meta Object

Field
Type
Description
Example

pageSize

integer

Items per page.

20

page

integer

Current page number.

0

total

string

Total operations available.

"250"

2. Operation Object (items[])

Field
Type
Description
Example

opid

string

Unique operation ID.

"op_12345"

isVisible

boolean

Visibility status.

true

status

string

Current status (see values above).

"SUCCESS"

type

string

Operation type (see values above).

"TRANSFER"

paymentType

string

Payment method.

"SWIFT"

createdAt

string

Creation timestamp (ISO 8601).

"2024-05-20T10:30:00Z"

updatedAt

string

Last update timestamp (ISO 8601).

"2024-05-20T14:45:00Z"

source

object

Source details (see below).

-

destination

object

Destination details (see below).

-

sourceAmount

object

Source amount (Money Object).

-

destinationAmount

object

Destination amount (Money Object).

-

commissionAmount

object

Commission amount (Money Object).

-

comment

string

Operation comment/notes.

"Monthly payment"

reference

string

Reference number.

"REF202405201234"

isParent

boolean

Parent operation flag.

true

customer

object

Customer details (see below).

-

documents

array

Associated documents (see below).

-

3. Source/Destination Objects

Contains nested objects for:

  • account: Account details (id, name, number, customer)

  • counterpartyAccount: Counterparty details with bank information

  • customer: Customer information (cuid, name, type)

4. Money Object

Used in sourceAmount, destinationAmount, commissionAmount:

Field
Type
Description
Example

currencyCode

string

Currency code (ISO 4217).

"USD"

units

string

Whole units.

"1000"

nanos

integer

Fractional units (10^-9).

500000000 (= $0.50)

5. Document Object

Field
Type
Description
Example

guid

string

Document unique ID.

"doc_abc123"

fileName

string

Original filename.

"invoice.pdf"

size

integer

File size in bytes.

1024000

mime

string

MIME type.

"application/pdf"

docType

string

Document type (see values in sample).

"BANK_STATEMENT"

createAt

string

Upload timestamp.

"2024-05-20T11:00:00Z"

Example Response:


Examples

Request

Request with Date Range


Error Responses

  1. Invalid Date Format:

  2. Unauthorized:


Notes

  • Status Flow: NEW → PENDING → WORKING → SUCCESS/FAIL/CANCELED

  • Money Precision: Use units + nanos for precise amounts (e.g., $100.50 = units="100", nanos=500000000)

  • Document Types: Various document types supported for compliance and verification

  • Pagination: Use for large datasets to manage performance

Request sample

Response sample

Last updated