List Wire Transfers

{
  "type": "object",
  "description": "A list of Wire Transfer objects",
  "required": [
    "data",
    "next_cursor"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "The contents of the list.",
      "items": {
        "type": "object",
        "description": "Wire transfers move funds between your Increase account and any other account accessible by Fedwire.",
        "required": [
          "id",
          "message_to_recipient",
          "amount",
          "currency",
          "account_number",
          "beneficiary_name",
          "beneficiary_address_line1",
          "beneficiary_address_line2",
          "beneficiary_address_line3",
          "account_id",
          "external_account_id",
          "routing_number",
          "approval",
          "cancellation",
          "reversal",
          "created_at",
          "network",
          "status",
          "submission",
          "template_id",
          "transaction_id",
          "type"
        ],
        "properties": {
          "account_id": {
            "type": "string",
            "description": "The Account to which the transfer belongs."
          },
          "account_number": {
            "type": "string",
            "description": "The destination account number."
          },
          "amount": {
            "type": "integer",
            "description": "The transfer amount in USD cents."
          },
          "approval": {
            "type": "object",
            "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.",
            "required": [
              "approved_at"
            ],
            "properties": {
              "approved_at": {
                "type": "string",
                "format": "date-time",
                "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved."
              }
            }
          },
          "beneficiary_address_line1": {
            "type": "string",
            "description": "The beneficiary's address line 1."
          },
          "beneficiary_address_line2": {
            "type": "string",
            "description": "The beneficiary's address line 2."
          },
          "beneficiary_address_line3": {
            "type": "string",
            "description": "The beneficiary's address line 3."
          },
          "beneficiary_name": {
            "type": "string",
            "description": "The beneficiary's name."
          },
          "cancellation": {
            "type": "object",
            "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.",
            "required": [
              "canceled_at"
            ],
            "properties": {
              "canceled_at": {
                "type": "string",
                "format": "date-time",
                "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled."
              }
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created."
          },
          "currency": {
            "type": "string",
            "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`.",
            "enum": [
              "CAD",
              "CHF",
              "EUR",
              "GBP",
              "JPY",
              "USD"
            ]
          },
          "external_account_id": {
            "type": "string",
            "description": "The identifier of the External Account the transfer was made to, if any."
          },
          "id": {
            "type": "string",
            "description": "The wire transfer's identifier."
          },
          "message_to_recipient": {
            "type": "string",
            "description": "The message that will show on the recipient's bank statement."
          },
          "network": {
            "type": "string",
            "description": "The transfer's network.",
            "enum": [
              "wire"
            ]
          },
          "reversal": {
            "type": "object",
            "description": "If your transfer is reversed, this will contain details of the reversal.",
            "required": [
              "amount",
              "description",
              "input_cycle_date",
              "input_sequence_number",
              "input_source",
              "input_message_accountability_data",
              "previous_message_input_message_accountability_data",
              "previous_message_input_cycle_date",
              "previous_message_input_sequence_number",
              "previous_message_input_source",
              "receiver_financial_institution_information",
              "financial_institution_to_financial_institution_information"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "description": "The amount that was reversed."
              },
              "description": {
                "type": "string",
                "description": "The description on the reversal message from Fedwire."
              },
              "financial_institution_to_financial_institution_information": {
                "type": "string",
                "description": "Additional financial institution information included in the wire reversal."
              },
              "input_cycle_date": {
                "type": "string",
                "format": "date",
                "description": "The Fedwire cycle date for the wire reversal."
              },
              "input_message_accountability_data": {
                "type": "string",
                "description": "The Fedwire transaction identifier."
              },
              "input_sequence_number": {
                "type": "string",
                "description": "The Fedwire sequence number."
              },
              "input_source": {
                "type": "string",
                "description": "The Fedwire input source identifier."
              },
              "previous_message_input_cycle_date": {
                "type": "string",
                "format": "date",
                "description": "The Fedwire cycle date for the wire transfer that was reversed."
              },
              "previous_message_input_message_accountability_data": {
                "type": "string",
                "description": "The Fedwire transaction identifier for the wire transfer that was reversed."
              },
              "previous_message_input_sequence_number": {
                "type": "string",
                "description": "The Fedwire sequence number for the wire transfer that was reversed."
              },
              "previous_message_input_source": {
                "type": "string",
                "description": "The Fedwire input source identifier for the wire transfer that was reversed."
              },
              "receiver_financial_institution_information": {
                "type": "string",
                "description": "Information included in the wire reversal for the receiving financial institution."
              }
            }
          },
          "routing_number": {
            "type": "string",
            "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN)."
          },
          "status": {
            "type": "string",
            "description": "The lifecycle status of the transfer.",
            "enum": [
              "canceled",
              "requires_attention",
              "pending_approval",
              "rejected",
              "reversed",
              "complete",
              "pending_creating"
            ]
          },
          "submission": {
            "type": "object",
            "description": "After the transfer is submitted to Fedwire, this will contain supplemental details.",
            "required": [
              "input_message_accountability_data",
              "submitted_at"
            ],
            "properties": {
              "input_message_accountability_data": {
                "type": "string",
                "description": "The accountability data for the submission."
              },
              "submitted_at": {
                "type": "string",
                "format": "date-time",
                "description": "When this wire transfer was submitted to Fedwire."
              }
            }
          },
          "template_id": {
            "type": "string",
            "description": "If the transfer was created from a template, this will be the template's ID."
          },
          "transaction_id": {
            "type": "string",
            "description": "The ID for the transaction funding the transfer."
          },
          "type": {
            "type": "string",
            "description": "A constant representing the object's type. For this resource it will always be `wire_transfer`.",
            "enum": [
              "wire_transfer"
            ]
          }
        }
      }
    },
    "next_cursor": {
      "type": "string",
      "description": "A pointer to a place in the list."
    }
  }
}