{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dwolla/main/json-schema/dwolla-transfers-schema.json",
  "title": "Transfers",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dwolla-accounts-api-openapi.yml#/components/schemas/Transfers",
  "type": "object",
  "properties": {
    "_links": {
      "additionalProperties": {
        "$ref": "#/$defs/HalLink"
      }
    },
    "_embedded": {
      "type": "object",
      "properties": {
        "transfers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Transfer"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    }
  },
  "$defs": {
    "HalLink": {
      "title": "HalLink",
      "type": "object",
      "properties": {
        "href": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "resource-type": {
          "type": "string"
        }
      }
    },
    "Transfer": {
      "title": "Transfer",
      "type": "object",
      "properties": {
        "_links": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/HalLink"
          }
        },
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "amount": {
          "type": "object",
          "properties": {
            "value": {
              "type": "string"
            },
            "currency": {
              "type": "string"
            }
          }
        },
        "created": {
          "type": "string",
          "format": "date-time"
        },
        "clearing": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string"
            },
            "destination": {
              "type": "string"
            }
          }
        },
        "metadata": {
          "type": "object",
          "properties": {
            "paymentId": {
              "type": "string"
            },
            "note": {
              "type": "string"
            }
          }
        },
        "achDetails": {
          "type": "object",
          "description": "ACH-specific details for the transfer. Present when transfer was processed via ACH network.",
          "properties": {
            "source": {
              "type": "object",
              "description": "Information sent to the source/originating bank account along with the transfer",
              "properties": {
                "addenda": {
                  "type": "object",
                  "description": "Contains addenda information for the transfer",
                  "properties": {
                    "values": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "An array containing a single string addenda value"
                    }
                  }
                },
                "beneficiaryName": {
                  "type": "string",
                  "description": "Beneficiary of the transaction's name. In general, should match the user onboarded to the Platform's name"
                },
                "companyEntryDescription": {
                  "type": "string",
                  "description": "Describes the purpose of the transaction",
                  "enum": [
                    "REVERSAL",
                    "RECLAIM",
                    "NO CHECK",
                    "AUTOENROLL",
                    "REDEPCHECK",
                    "RETURN FEE",
                    "RETRY PMNT",
                    "HEALTHCARE",
                    "PAYMENT"
                  ]
                },
                "companyId": {
                  "type": "string",
                  "description": "Numeric identifier of originator"
                },
                "companyName": {
                  "type": "string",
                  "description": "Name of the originator"
                },
                "effectiveDate": {
                  "type": "string",
                  "format": "date",
                  "description": "The date when the ACH transaction becomes effective, formatted as YYYY-MM-DD. This is typically the settlement date for the transaction"
                },
                "postingData": {
                  "type": "string",
                  "description": "Suggested memo line format for bank statements, structured as companyName:companyDiscretionaryData:beneficiaryName"
                },
                "routingNumber": {
                  "type": "string",
                  "description": "Routing number of Originating Depository Financial Institution (ODFI). Identifies the financial institution that originated the ACH transaction"
                },
                "traceId": {
                  "type": "string",
                  "description": "A unique identifier for tracing the ACH transaction through the banking network. Used for transaction tracking and reconciliation purposes"
                }
              }
            },
            "destination": {
              "type": "object",
              "description": "Information sent to the destination/receiving bank account along with the transfer",
              "properties": {
                "addenda": {
                  "type": "object",
                  "description": "Contains addenda information for the transfer",
                  "properties": {
                    "values": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "An array containing a single string addenda value"
                    }
                  }
                },
                "beneficiaryName": {
                  "type": "string",
                  "description": "Beneficiary of the transaction's name. In general, should match the user onboarded to the Platform's name"
                },
                "companyEntryDescription": {
                  "type": "string",
                  "description": "Describes the purpose of the transaction",
                  "enum": [
                    "REVERSAL",
                    "RECLAIM",
                    "NO CHECK",
                    "AUTOENROLL",
                    "REDEPCHECK",
                    "RETURN FEE",
                    "RETRY PMNT",
                    "HEALTHCARE",
                    "PAYMENT"
                  ]
                },
                "companyId": {
                  "type": "string",
                  "description": "Numeric identifier of originator"
                },
                "companyName": {
                  "type": "string",
                  "description": "Name of the originator"
                },
                "effectiveDate": {
                  "type": "string",
                  "format": "date",
                  "description": "The date when the ACH transaction becomes effective, formatted as YYYY-MM-DD. This is typically the settlement date for the transaction"
                },
                "postingData": {
                  "type": "string",
                  "description": "Suggested memo line format for bank statements, structured as companyName:companyDiscretionaryData:beneficiaryName"
                },
                "routingNumber": {
                  "type": "string",
                  "description": "Routing number of Originating Depository Financial Institution (ODFI). Identifies the financial institution that originated the ACH transaction"
                },
                "traceId": {
                  "type": "string",
                  "description": "A unique identifier for tracing the ACH transaction through the banking network. Used for transaction tracking and reconciliation purposes"
                }
              }
            }
          }
        },
        "rtpDetails": {
          "type": "object",
          "description": "Real-Time Payments (RTP) network specific details. Present when transfer was processed via RTP network.",
          "properties": {
            "destination": {
              "type": "object",
              "description": "RTP destination details with network identifiers",
              "properties": {
                "remittanceData": {
                  "type": "string",
                  "description": "Remittance information included in the transfer request"
                },
                "networkId": {
                  "type": "string",
                  "description": "Unique identifier for the transfer within the RTP network"
                },
                "endToEndReferenceId": {
                  "type": "string",
                  "description": "End-to-end reference identifier for the RTP transfer"
                }
              }
            }
          }
        },
        "fedNowDetails": {
          "type": "object",
          "description": "FedNow Service network specific details. Present when transfer was processed via FedNow network.",
          "properties": {
            "destination": {
              "type": "object",
              "description": "FedNow destination details with network identifiers",
              "properties": {
                "remittanceData": {
                  "type": "string",
                  "description": "Remittance information included in the transfer request"
                },
                "networkId": {
                  "type": "string",
                  "description": "Unique identifier for the transfer within the FedNow network"
                },
                "endToEndReferenceId": {
                  "type": "string",
                  "description": "End-to-end reference identifier for the FedNow transfer"
                }
              }
            }
          }
        },
        "correlationId": {
          "type": "string"
        },
        "processingChannel": {
          "type": "object",
          "properties": {
            "destination": {
              "type": "string",
              "enum": [
                "real-time-payments",
                "fed-now"
              ],
              "description": "The payment network used to process the transfer"
            }
          }
        }
      }
    }
  }
}