ledger_transaction_reversal_create_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
description	string	An optional free-form description for the reversal ledger transaction. Maximum of 1000 characters allowed.
status	string	Status of the reversal ledger transaction. It defaults to `posted` if not provided.
metadata	object	Additional data to be added to the reversal ledger transaction as key-value pairs. Both the key and value must be strings.
effective_at	string	The timestamp (ISO8601 format) at which the reversal ledger transaction happened for reporting purposes. It defaults to the `effective_at` of the original ledger transaction if not provided.
external_id	string	Must be unique within the ledger.
ledgerable_type	string	Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal.
ledgerable_id	string	Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ledger_transaction_reversal_create_request",
  "title": "ledger_transaction_reversal_create_request",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "An optional free-form description for the reversal ledger transaction. Maximum of 1000 characters allowed."
    },
    "status": {
      "type": "string",
      "enum": [
        "archived",
        "pending",
        "posted"
      ],
      "description": "Status of the reversal ledger transaction. It defaults to `posted` if not provided."
    },
    "metadata": {
      "type": "object",
      "description": "Additional data to be added to the reversal ledger transaction as key-value pairs. Both the key and value must be strings.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      }
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp (ISO8601 format) at which the reversal ledger transaction happened for reporting purposes. It defaults to the `effective_at` of the original ledger transaction if not provided.",
      "nullable": true
    },
    "external_id": {
      "type": "string",
      "description": "Must be unique within the ledger."
    },
    "ledgerable_type": {
      "type": "string",
      "enum": [
        "expected_payment",
        "incoming_payment_detail",
        "payment_order",
        "return",
        "reversal"
      ],
      "description": "Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal."
    },
    "ledgerable_id": {
      "type": "string",
      "format": "uuid",
      "description": "Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal."
    }
  }
}