GET api/Beneficiary/GetList

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BeneficiaryAPIModel

Name	Type	Additional information
Beneficiary	BeneficiaryDto	None.
InvalidParameters	Collection of InvalidParameter	None.
IsComplete	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "beneficiary": {
      "id": "625515a4-d38b-4a06-bac7-d1e0c17b14bd",
      "bankAccountHolderName": "sample string 1",
      "bankAccountBeneficiaryHebrewName": "sample string 2",
      "companyName": "sample string 3",
      "status": 4,
      "statusDesc": "updatedfile",
      "approved": false,
      "currency": "sample string 5",
      "activeCurrency": true,
      "bankCountry": "sample string 6",
      "beneficiaryStateResidenceRecipient": "sample string 7",
      "deductionNum": "sample string 8",
      "bankAccountHolderEmail": "sample string 9",
      "bankAccountHolderNickname": "sample string 10",
      "bankAddress": "sample string 11",
      "bankCountryFullName": "sample string 12",
      "bankName": "sample string 13",
      "ownAccount": 1,
      "entityType": 1,
      "paymentType": 1,
      "updatedAt": "2025-05-13T04:43:23.1009236+03:00",
      "paymentReason": 1,
      "paymentTerms": 1,
      "reasonDesc": "sample string 15",
      "beneficiaryAddress": "sample string 16",
      "bicSwift": "sample string 17",
      "aba": "sample string 18",
      "iban": "sample string 19",
      "fileName": "sample string 20",
      "fileExtension": "sample string 21",
      "fileId": "b3295f34-139d-4924-aebd-8faedbbcb031",
      "accountNumber": "sample string 22",
      "beneficiaryCountry": "sample string 23",
      "hasPayment": true,
      "lastActive": "2025-05-13T04:43:23.1009236+03:00",
      "salesforceID": "sample string 25",
      "accountType": 1,
      "zip": "sample string 26",
      "city": "sample string 27",
      "specialRelations": true,
      "chinaApproved": true,
      "houseNum": "sample string 30",
      "idNum": "sample string 31",
      "streetAddress": "sample string 32",
      "gender": 1,
      "birthDate": "2025-05-13T04:43:23.1009236+03:00",
      "unionDate": "2025-05-13T04:43:23.1009236+03:00",
      "stateOrProvince": "sample string 33",
      "bankBranch": "sample string 34",
      "bankNumber": "sample string 35",
      "files": [
        {
          "docType": 1,
          "fileId": "sample string 2"
        },
        {
          "docType": 1,
          "fileId": "sample string 2"
        }
      ],
      "greenChannel": true,
      "existingInBlacklisted": 1,
      "nR_PDF": "sample string 36",
      "referenceIdBlacklisted": "sample string 37",
      "fileIdBlacklisted": "fa7aafe0-6d89-4641-9ab1-515f3e4cef86",
      "uploadStatus": 1
    },
    "invalidParameters": [
      {
        "parameter": "sample string 1",
        "validationError": "sample string 2"
      },
      {
        "parameter": "sample string 1",
        "validationError": "sample string 2"
      }
    ],
    "isComplete": true
  },
  {
    "beneficiary": {
      "id": "625515a4-d38b-4a06-bac7-d1e0c17b14bd",
      "bankAccountHolderName": "sample string 1",
      "bankAccountBeneficiaryHebrewName": "sample string 2",
      "companyName": "sample string 3",
      "status": 4,
      "statusDesc": "updatedfile",
      "approved": false,
      "currency": "sample string 5",
      "activeCurrency": true,
      "bankCountry": "sample string 6",
      "beneficiaryStateResidenceRecipient": "sample string 7",
      "deductionNum": "sample string 8",
      "bankAccountHolderEmail": "sample string 9",
      "bankAccountHolderNickname": "sample string 10",
      "bankAddress": "sample string 11",
      "bankCountryFullName": "sample string 12",
      "bankName": "sample string 13",
      "ownAccount": 1,
      "entityType": 1,
      "paymentType": 1,
      "updatedAt": "2025-05-13T04:43:23.1009236+03:00",
      "paymentReason": 1,
      "paymentTerms": 1,
      "reasonDesc": "sample string 15",
      "beneficiaryAddress": "sample string 16",
      "bicSwift": "sample string 17",
      "aba": "sample string 18",
      "iban": "sample string 19",
      "fileName": "sample string 20",
      "fileExtension": "sample string 21",
      "fileId": "b3295f34-139d-4924-aebd-8faedbbcb031",
      "accountNumber": "sample string 22",
      "beneficiaryCountry": "sample string 23",
      "hasPayment": true,
      "lastActive": "2025-05-13T04:43:23.1009236+03:00",
      "salesforceID": "sample string 25",
      "accountType": 1,
      "zip": "sample string 26",
      "city": "sample string 27",
      "specialRelations": true,
      "chinaApproved": true,
      "houseNum": "sample string 30",
      "idNum": "sample string 31",
      "streetAddress": "sample string 32",
      "gender": 1,
      "birthDate": "2025-05-13T04:43:23.1009236+03:00",
      "unionDate": "2025-05-13T04:43:23.1009236+03:00",
      "stateOrProvince": "sample string 33",
      "bankBranch": "sample string 34",
      "bankNumber": "sample string 35",
      "files": [
        {
          "docType": 1,
          "fileId": "sample string 2"
        },
        {
          "docType": 1,
          "fileId": "sample string 2"
        }
      ],
      "greenChannel": true,
      "existingInBlacklisted": 1,
      "nR_PDF": "sample string 36",
      "referenceIdBlacklisted": "sample string 37",
      "fileIdBlacklisted": "fa7aafe0-6d89-4641-9ab1-515f3e4cef86",
      "uploadStatus": 1
    },
    "invalidParameters": [
      {
        "parameter": "sample string 1",
        "validationError": "sample string 2"
      },
      {
        "parameter": "sample string 1",
        "validationError": "sample string 2"
      }
    ],
    "isComplete": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfBeneficiaryAPIModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EvenEdgeService.Models">
  <BeneficiaryAPIModel>
    <Beneficiary>
      <Aba>sample string 18</Aba>
      <AccountNumber>sample string 22</AccountNumber>
      <AccountType>1</AccountType>
      <ActiveCurrency>true</ActiveCurrency>
      <BankAccountHolderName>sample string 1</BankAccountHolderName>
      <BankBranch>sample string 34</BankBranch>
      <BankCountry>sample string 6</BankCountry>
      <BankCountryFullName>sample string 12</BankCountryFullName>
      <BankName>sample string 13</BankName>
      <BankNumber>sample string 35</BankNumber>
      <BeneficiaryAddress>sample string 16</BeneficiaryAddress>
      <BeneficiaryCountry>sample string 23</BeneficiaryCountry>
      <BicSwift>sample string 17</BicSwift>
      <BirthDate>2025-05-13T04:43:23.1009236+03:00</BirthDate>
      <ChinaApproved>true</ChinaApproved>
      <City>sample string 27</City>
      <CompanyName>sample string 3</CompanyName>
      <Currency>sample string 5</Currency>
      <DeductionNum>sample string 8</DeductionNum>
      <EntityType>Company</EntityType>
      <ExistingInBlacklisted>1</ExistingInBlacklisted>
      <FileExtension>sample string 21</FileExtension>
      <FileId>b3295f34-139d-4924-aebd-8faedbbcb031</FileId>
      <FileIdBlacklisted>fa7aafe0-6d89-4641-9ab1-515f3e4cef86</FileIdBlacklisted>
      <FileName>sample string 20</FileName>
      <Files>
        <BeneficiaryFileDto>
          <DocType>1</DocType>
          <FileId>sample string 2</FileId>
        </BeneficiaryFileDto>
        <BeneficiaryFileDto>
          <DocType>1</DocType>
          <FileId>sample string 2</FileId>
        </BeneficiaryFileDto>
      </Files>
      <Gender>1</Gender>
      <HasPayment>true</HasPayment>
      <HouseNum>sample string 30</HouseNum>
      <Iban>sample string 19</Iban>
      <Id>625515a4-d38b-4a06-bac7-d1e0c17b14bd</Id>
      <IdNum>sample string 31</IdNum>
      <LastActive>2025-05-13T04:43:23.1009236+03:00</LastActive>
      <NR_PDF>sample string 36</NR_PDF>
      <OwnAccount>1</OwnAccount>
      <PaymentReason>1</PaymentReason>
      <PaymentTerms>1</PaymentTerms>
      <PaymentType>Priority</PaymentType>
      <ReasonDesc>sample string 15</ReasonDesc>
      <ReferenceIdBlacklisted>sample string 37</ReferenceIdBlacklisted>
      <SalesforceID>sample string 25</SalesforceID>
      <SpecialRelations>true</SpecialRelations>
      <StateOrProvince>sample string 33</StateOrProvince>
      <Status>4</Status>
      <StreetAddress>sample string 32</StreetAddress>
      <UnionDate>2025-05-13T04:43:23.1009236+03:00</UnionDate>
      <UpdatedAt>2025-05-13T04:43:23.1009236+03:00</UpdatedAt>
      <UploadStatus>1</UploadStatus>
      <Zip>sample string 26</Zip>
      <bankAccountBeneficiaryHebrewName>sample string 2</bankAccountBeneficiaryHebrewName>
      <bankAccountHolderEmail>sample string 9</bankAccountHolderEmail>
      <bankAccountHolderNickname>sample string 10</bankAccountHolderNickname>
      <bankAddress>sample string 11</bankAddress>
      <beneficiaryStateResidenceRecipient>sample string 7</beneficiaryStateResidenceRecipient>
    </Beneficiary>
    <InvalidParameters>
      <InvalidParameter>
        <Parameter>sample string 1</Parameter>
        <ValidationError>sample string 2</ValidationError>
      </InvalidParameter>
      <InvalidParameter>
        <Parameter>sample string 1</Parameter>
        <ValidationError>sample string 2</ValidationError>
      </InvalidParameter>
    </InvalidParameters>
    <IsComplete>true</IsComplete>
  </BeneficiaryAPIModel>
  <BeneficiaryAPIModel>
    <Beneficiary>
      <Aba>sample string 18</Aba>
      <AccountNumber>sample string 22</AccountNumber>
      <AccountType>1</AccountType>
      <ActiveCurrency>true</ActiveCurrency>
      <BankAccountHolderName>sample string 1</BankAccountHolderName>
      <BankBranch>sample string 34</BankBranch>
      <BankCountry>sample string 6</BankCountry>
      <BankCountryFullName>sample string 12</BankCountryFullName>
      <BankName>sample string 13</BankName>
      <BankNumber>sample string 35</BankNumber>
      <BeneficiaryAddress>sample string 16</BeneficiaryAddress>
      <BeneficiaryCountry>sample string 23</BeneficiaryCountry>
      <BicSwift>sample string 17</BicSwift>
      <BirthDate>2025-05-13T04:43:23.1009236+03:00</BirthDate>
      <ChinaApproved>true</ChinaApproved>
      <City>sample string 27</City>
      <CompanyName>sample string 3</CompanyName>
      <Currency>sample string 5</Currency>
      <DeductionNum>sample string 8</DeductionNum>
      <EntityType>Company</EntityType>
      <ExistingInBlacklisted>1</ExistingInBlacklisted>
      <FileExtension>sample string 21</FileExtension>
      <FileId>b3295f34-139d-4924-aebd-8faedbbcb031</FileId>
      <FileIdBlacklisted>fa7aafe0-6d89-4641-9ab1-515f3e4cef86</FileIdBlacklisted>
      <FileName>sample string 20</FileName>
      <Files>
        <BeneficiaryFileDto>
          <DocType>1</DocType>
          <FileId>sample string 2</FileId>
        </BeneficiaryFileDto>
        <BeneficiaryFileDto>
          <DocType>1</DocType>
          <FileId>sample string 2</FileId>
        </BeneficiaryFileDto>
      </Files>
      <Gender>1</Gender>
      <HasPayment>true</HasPayment>
      <HouseNum>sample string 30</HouseNum>
      <Iban>sample string 19</Iban>
      <Id>625515a4-d38b-4a06-bac7-d1e0c17b14bd</Id>
      <IdNum>sample string 31</IdNum>
      <LastActive>2025-05-13T04:43:23.1009236+03:00</LastActive>
      <NR_PDF>sample string 36</NR_PDF>
      <OwnAccount>1</OwnAccount>
      <PaymentReason>1</PaymentReason>
      <PaymentTerms>1</PaymentTerms>
      <PaymentType>Priority</PaymentType>
      <ReasonDesc>sample string 15</ReasonDesc>
      <ReferenceIdBlacklisted>sample string 37</ReferenceIdBlacklisted>
      <SalesforceID>sample string 25</SalesforceID>
      <SpecialRelations>true</SpecialRelations>
      <StateOrProvince>sample string 33</StateOrProvince>
      <Status>4</Status>
      <StreetAddress>sample string 32</StreetAddress>
      <UnionDate>2025-05-13T04:43:23.1009236+03:00</UnionDate>
      <UpdatedAt>2025-05-13T04:43:23.1009236+03:00</UpdatedAt>
      <UploadStatus>1</UploadStatus>
      <Zip>sample string 26</Zip>
      <bankAccountBeneficiaryHebrewName>sample string 2</bankAccountBeneficiaryHebrewName>
      <bankAccountHolderEmail>sample string 9</bankAccountHolderEmail>
      <bankAccountHolderNickname>sample string 10</bankAccountHolderNickname>
      <bankAddress>sample string 11</bankAddress>
      <beneficiaryStateResidenceRecipient>sample string 7</beneficiaryStateResidenceRecipient>
    </Beneficiary>
    <InvalidParameters>
      <InvalidParameter>
        <Parameter>sample string 1</Parameter>
        <ValidationError>sample string 2</ValidationError>
      </InvalidParameter>
      <InvalidParameter>
        <Parameter>sample string 1</Parameter>
        <ValidationError>sample string 2</ValidationError>
      </InvalidParameter>
    </InvalidParameters>
    <IsComplete>true</IsComplete>
  </BeneficiaryAPIModel>
</ArrayOfBeneficiaryAPIModel>