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

Get Operation

Retrieves detailed information about a specific financial operation, including complete transaction details, amounts, status, and associated documents.

Endpoint

GET/v2/billing/operation/{id}

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

id

string

Operation ID to retrieve.

Yes

"op_12345"

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns the complete operation object with all details.

Response Fields

Operation Object

Field
Type
Description
Example

opid

string

Unique operation ID.

"op_12345"

isVisible

boolean

Visibility status.

true

status

string

Current status: - NEW: Created - PENDING: Under review - WORKING: Processing - SUCCESS: Completed - FAIL: Failed - CANCELED: Canceled

"SUCCESS"

type

string

Operation type: - NOTSET - DEPOSIT - TRANSFER - WITHDRAW - COMMISSION - EXCHANGE - CORRECTING

"TRANSFER"

paymentType

string

Payment method: - EMPTY - ACH - FEDWIRE - SWIFT - CRYPTO - EFT - SEPA_CT - IMPS

"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 account details.

-

destination

object

Destination account details.

-

sourceAmount

object

Source amount with currency.

-

destinationAmount

object

Destination amount with currency.

-

commissionAmount

object

Commission amount with currency.

-

currentBalanceAmount

object

Current balance after operation.

-

comment

string

Operation comment/notes.

"Supplier payment"

isParent

boolean

Parent operation flag.

true

reference

string

Reference number.

"REF202405201234"

customer

object

Customer details.

-

documents

array

Associated documents.

-

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)

Money Object

Used in amount fields:

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)

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 (Successful Transfer):

Example Response (Pending Withdrawal):


Examples

Request


Error Responses

  1. Operation Not Found:

  2. Unauthorized:


Notes

  • Status Tracking: Use to monitor operation progress through status changes

  • Audit Trail: Provides complete transaction history for compliance

  • Document Management: Shows all documents associated with the operation

  • Balance Information: Includes current balance reflecting the operation's impact

  • Real-time Data: Reflects the most current operation state

Common Use Cases:

  • Operation status monitoring

  • Transaction details for customer support

  • Audit and compliance reporting

  • Document verification

Request sample

Response sample

Last updated