Lithic API Documentation | Management Operations

Management Operations

management_operations

Methods

List Management Operations -> CursorPage<

ManagementOperationTransaction

get/v1/management_operations

List management operations

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

business_account_token: string

Optional

(format: uuid)

category:

Optional

Management operation category to be returned.

"MANAGEMENT_FEE"

"MANAGEMENT_DISPUTE"

"MANAGEMENT_REWARD"

"MANAGEMENT_ADJUSTMENT"

"MANAGEMENT_DISBURSEMENT"

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

financial_account_token: string

Optional

(format: uuid)

Globally unique identifier for the financial account. Accepted type dependent on the program's use case.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

status:

Optional

Management operation status to be returned.

"PENDING"

"SETTLED"

"DECLINED"

"REVERSED"

"CANCELED"

"RETURNED"

Response fields

data: Array<

ManagementOperationTransaction

has_more: boolean

Request example

curl https://api.lithic.com/v1/management_operations \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created": "2019-12-27T18:11:19.117Z",
      "status": "PENDING",
      "updated": "2019-12-27T18:11:19.117Z",
      "category": "MANAGEMENT_FEE",
      "currency": "currency",
      "direction": "CREDIT",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "amount": 0,
          "created": "2019-12-27T18:11:19.117Z",
          "detailed_results": [
            "APPROVED"
          ],
          "effective_date": "2019-12-27",
          "memo": "memo",
          "result": "APPROVED",
          "type": "LOSS_WRITE_OFF",
          "subtype": "subtype"
        }
      ],
      "external_resource": {
        "external_resource_token": "external_resource_token",
        "external_resource_type": "STATEMENT",
        "external_resource_sub_token": "external_resource_sub_token"
      },
      "family": "MANAGEMENT_OPERATION",
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 0,
      "result": "APPROVED",
      "settled_amount": 0,
      "transaction_series": {
        "related_transaction_event_token": "123e4567-e89b-12d3-a456-426614174000",
        "related_transaction_token": "123e4567-e89b-12d3-a456-426614174000",
        "type": "FEE"
      },
      "user_defined_id": "user_defined_id"
    }
  ],
  "has_more": true
}

Create Management Operation ->

ManagementOperationTransaction

post/v1/management_operations

Create management operation

Get Management Operation ->

ManagementOperationTransaction

get/v1/management_operations/{management_operation_token}

Get management operation

Reverse Management Operation ->

ManagementOperationTransaction

post/v1/management_operations/{management_operation_token}/reverse

Reverse a management operation

Domain types

ExternalResource = { external_resource_token, external_resource_type, external_resource_sub_token }

External resource associated with the management operation

ExternalResourceType = "STATEMENT" | "COLLECTION" | "DISPUTE" | 1 more...

Type of external resource associated with the management operation

ManagementOperationTransaction = { token, created, status, 13 more... }