Management Operations

Create management operation

Changed on

Create management operation

post/v1/management_operations

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/management_operations
  • Auth
    API key in header Authorization

Request body

category'MANAGEMENT_FEE' | 'MANAGEMENT_DISPUTE' | 'MANAGEMENT_REWARD' | 'MANAGEMENT_ADJUSTMENT' | 'MANAGEMENT_DISBURSEMENT' required
event_type'LOSS_WRITE_OFF' | 'CASH_BACK' | 'CASH_BACK_REVERSAL' | 'CURRENCY_CONVERSION' | 'CURRENCY_CONVERSION_REVERSAL' | 'INTEREST' | 'INTEREST_REVERSAL' | 'INSTALLMENT_FEE' | 'INSTALLMENT_FEE_REVERSAL' | 'LATE_PAYMENT' | 'LATE_PAYMENT_REVERSAL' | 'BILLING_ERROR' | 'BILLING_ERROR_REVERSAL' | 'PROVISIONAL_CREDIT' | 'PROVISIONAL_CREDIT_REVERSAL' | 'RETURNED_PAYMENT' | 'RETURNED_PAYMENT_REVERSAL' | 'DISPUTE_WON' | 'DISPUTE_WON_REVERSAL' | 'DISBURSE' | 'DISBURSE_REVERSAL' | 'ANNUAL' | 'ANNUAL_REVERSAL' | 'QUARTERLY' | 'QUARTERLY_REVERSAL' | 'MONTHLY' | 'MONTHLY_REVERSAL' | 'FEE' | 'FEE_REVERSAL' required
subtypestring
financial_account_tokenstring uuid required
amountinteger required
memostring
user_defined_idstring
effective_datestring date required
tokenstring uuid

Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

direction'CREDIT' | 'DEBIT' required
on_closed_account'FAIL' | 'USE_SUSPENSE'

What to do if the financial account is closed when posting an operation

Response

OK

tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED' required
family'MANAGEMENT_OPERATION' required

MANAGEMENT_OPERATION - Management Operation Transaction

result'APPROVED' | 'DECLINED' required
category'MANAGEMENT_FEE' | 'MANAGEMENT_DISPUTE' | 'MANAGEMENT_REWARD' | 'MANAGEMENT_ADJUSTMENT' | 'MANAGEMENT_DISBURSEMENT' required
settled_amountinteger required
pending_amountinteger required
currencystring required
user_defined_idstring nullable
financial_account_tokenstring uuid required
direction'CREDIT' | 'DEBIT' required

Example response

{
  "transaction_series": {
    "type": "FEE",
    "related_transaction_token": "123e4567-e89b-12d3-a456-426614174000",
    "related_transaction_event_token": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

  • 9798275dc379Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #2 to the response property allOf list for the response status

  • dc3c4d014332Revision changes
    • warning

      added the new FEE enum value to the /// response property for the response status

    • warning

      added the new FEE_REVERSAL enum value to the /// response property for the response status

    • info

      added the new FEE enum value to the request property

    • info

      added the new FEE_REVERSAL enum value to the request property