GET api/KfsTransfer?receiptNumber={receiptNumber}&kfsKey={kfsKey}&batchNumber={batchNumber}

Request Information

URI Parameters

Name	Type	Additional information
receiptNumber	string	None.
kfsKey	string	None.
batchNumber	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of KfsTransferRequest

Name	Type	Additional information
GiftFeeType	string	Required
AppealCode	string	None.
Account	string	Required
FundName	string	Required
FundIsCurrent	boolean	None.
FundIsQuasi	boolean	None.
FundIsEndowment	boolean	None.
KfsAccount	string	None.
KfsSubAccount	string	None.
AdvanceUcFund	string	None.
UcFund	string	None.
HasAfFee	boolean	None.
NumPremiums	integer	None.
Premiums	Collection of PremiumDetails	None.
AllocationType	string	None.
IsActiveAllocation	boolean	None.
ErrorMessage	string	None.
DoNotProcess	boolean	None.
EndowmentPoolCode	string	Required
IsShortTermInvestmentPool	boolean	None.
DonorName	string	Required
Amount	decimal number	Required
AllocationCode	string	Required
DepartmentCode	string	Required
Agency	string	Required
TransactionId	string	None.
KfsKey	string	Required
AuthCode	string	Required
AuthorizedAt	date	Required
PaymentType	PaymentType	None.
MerchantId	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "giftFeeType": "sample string 1",
    "appealCode": "sample string 2",
    "account": "sample string 3",
    "fundName": "sample string 4",
    "fundIsCurrent": false,
    "fundIsQuasi": false,
    "fundIsEndowment": false,
    "kfsAccount": "sample string 5",
    "kfsSubAccount": "sample string 6",
    "advanceUcFund": "sample string 7",
    "ucFund": null,
    "hasAfFee": true,
    "numPremiums": 9,
    "premiums": [
      {
        "declined": true,
        "receiptNumber": "sample string 2",
        "code": "sample string 3",
        "sequenceNumber": "sample string 4",
        "commentOnly": "sample string 5",
        "comment": "sample string 5",
        "chart": null,
        "account": null,
        "subAccount": null,
        "amount": 6.0
      },
      {
        "declined": true,
        "receiptNumber": "sample string 2",
        "code": "sample string 3",
        "sequenceNumber": "sample string 4",
        "commentOnly": "sample string 5",
        "comment": "sample string 5",
        "chart": null,
        "account": null,
        "subAccount": null,
        "amount": 6.0
      }
    ],
    "allocationType": "sample string 10",
    "isActiveAllocation": true,
    "errorMessage": "sample string 12",
    "doNotProcess": true,
    "endowmentPoolCode": "sample string 14",
    "isShortTermInvestmentPool": false,
    "donorName": "sample string 15",
    "amount": 16.0,
    "allocationCode": "sample string 17",
    "departmentCode": "sample string 18",
    "agency": "sample string 19",
    "transactionId": "sample string 20",
    "kfsKey": "sample string 21",
    "authCode": "sample string 22",
    "authorizedAt": "2024-06-24T20:48:19.1847047-07:00",
    "paymentType": 0,
    "merchantId": "sample string 24"
  },
  {
    "giftFeeType": "sample string 1",
    "appealCode": "sample string 2",
    "account": "sample string 3",
    "fundName": "sample string 4",
    "fundIsCurrent": false,
    "fundIsQuasi": false,
    "fundIsEndowment": false,
    "kfsAccount": "sample string 5",
    "kfsSubAccount": "sample string 6",
    "advanceUcFund": "sample string 7",
    "ucFund": null,
    "hasAfFee": true,
    "numPremiums": 9,
    "premiums": [
      {
        "declined": true,
        "receiptNumber": "sample string 2",
        "code": "sample string 3",
        "sequenceNumber": "sample string 4",
        "commentOnly": "sample string 5",
        "comment": "sample string 5",
        "chart": null,
        "account": null,
        "subAccount": null,
        "amount": 6.0
      },
      {
        "declined": true,
        "receiptNumber": "sample string 2",
        "code": "sample string 3",
        "sequenceNumber": "sample string 4",
        "commentOnly": "sample string 5",
        "comment": "sample string 5",
        "chart": null,
        "account": null,
        "subAccount": null,
        "amount": 6.0
      }
    ],
    "allocationType": "sample string 10",
    "isActiveAllocation": true,
    "errorMessage": "sample string 12",
    "doNotProcess": true,
    "endowmentPoolCode": "sample string 14",
    "isShortTermInvestmentPool": false,
    "donorName": "sample string 15",
    "amount": 16.0,
    "allocationCode": "sample string 17",
    "departmentCode": "sample string 18",
    "agency": "sample string 19",
    "transactionId": "sample string 20",
    "kfsKey": "sample string 21",
    "authCode": "sample string 22",
    "authorizedAt": "2024-06-24T20:48:19.1847047-07:00",
    "paymentType": 0,
    "merchantId": "sample string 24"
  }
]

application/xml, text/xml

Sample:

<ArrayOfKfsTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GivingService.Models">
  <KfsTransferRequest>
    <Agency>sample string 19</Agency>
    <AllocationCode>sample string 17</AllocationCode>
    <Amount>16</Amount>
    <AuthCode>sample string 22</AuthCode>
    <AuthorizedAt>2024-06-24T20:48:19.1847047-07:00</AuthorizedAt>
    <DepartmentCode>sample string 18</DepartmentCode>
    <DonorName>sample string 15</DonorName>
    <KfsKey>sample string 21</KfsKey>
    <MerchantId>sample string 24</MerchantId>
    <PaymentType>Check</PaymentType>
    <TransactionId>sample string 20</TransactionId>
    <Account>sample string 3</Account>
    <AllocationType>sample string 10</AllocationType>
    <AppealCode>sample string 2</AppealCode>
    <DoNotProcess>true</DoNotProcess>
    <EndowmentPoolCode>sample string 14</EndowmentPoolCode>
    <ErrorMessage>sample string 12</ErrorMessage>
    <FundName>sample string 4</FundName>
    <GiftFeeType>sample string 1</GiftFeeType>
    <HasAfFee>true</HasAfFee>
    <IsActiveAllocation>true</IsActiveAllocation>
    <KfsAccount>sample string 5</KfsAccount>
    <KfsSubAccount>sample string 6</KfsSubAccount>
    <NumPremiums>9</NumPremiums>
    <Premiums xmlns:d3p1="http://schemas.datacontract.org/2004/07/GiftModels">
      <d3p1:PremiumDetails>
        <d3p1:Amount>6</d3p1:Amount>
        <d3p1:Code>sample string 3</d3p1:Code>
        <d3p1:Comment>sample string 5</d3p1:Comment>
        <d3p1:Declined>true</d3p1:Declined>
        <d3p1:ReceiptNumber>sample string 2</d3p1:ReceiptNumber>
        <d3p1:SequenceNumber>sample string 4</d3p1:SequenceNumber>
      </d3p1:PremiumDetails>
      <d3p1:PremiumDetails>
        <d3p1:Amount>6</d3p1:Amount>
        <d3p1:Code>sample string 3</d3p1:Code>
        <d3p1:Comment>sample string 5</d3p1:Comment>
        <d3p1:Declined>true</d3p1:Declined>
        <d3p1:ReceiptNumber>sample string 2</d3p1:ReceiptNumber>
        <d3p1:SequenceNumber>sample string 4</d3p1:SequenceNumber>
      </d3p1:PremiumDetails>
    </Premiums>
    <UcFund i:nil="true" />
  </KfsTransferRequest>
  <KfsTransferRequest>
    <Agency>sample string 19</Agency>
    <AllocationCode>sample string 17</AllocationCode>
    <Amount>16</Amount>
    <AuthCode>sample string 22</AuthCode>
    <AuthorizedAt>2024-06-24T20:48:19.1847047-07:00</AuthorizedAt>
    <DepartmentCode>sample string 18</DepartmentCode>
    <DonorName>sample string 15</DonorName>
    <KfsKey>sample string 21</KfsKey>
    <MerchantId>sample string 24</MerchantId>
    <PaymentType>Check</PaymentType>
    <TransactionId>sample string 20</TransactionId>
    <Account>sample string 3</Account>
    <AllocationType>sample string 10</AllocationType>
    <AppealCode>sample string 2</AppealCode>
    <DoNotProcess>true</DoNotProcess>
    <EndowmentPoolCode>sample string 14</EndowmentPoolCode>
    <ErrorMessage>sample string 12</ErrorMessage>
    <FundName>sample string 4</FundName>
    <GiftFeeType>sample string 1</GiftFeeType>
    <HasAfFee>true</HasAfFee>
    <IsActiveAllocation>true</IsActiveAllocation>
    <KfsAccount>sample string 5</KfsAccount>
    <KfsSubAccount>sample string 6</KfsSubAccount>
    <NumPremiums>9</NumPremiums>
    <Premiums xmlns:d3p1="http://schemas.datacontract.org/2004/07/GiftModels">
      <d3p1:PremiumDetails>
        <d3p1:Amount>6</d3p1:Amount>
        <d3p1:Code>sample string 3</d3p1:Code>
        <d3p1:Comment>sample string 5</d3p1:Comment>
        <d3p1:Declined>true</d3p1:Declined>
        <d3p1:ReceiptNumber>sample string 2</d3p1:ReceiptNumber>
        <d3p1:SequenceNumber>sample string 4</d3p1:SequenceNumber>
      </d3p1:PremiumDetails>
      <d3p1:PremiumDetails>
        <d3p1:Amount>6</d3p1:Amount>
        <d3p1:Code>sample string 3</d3p1:Code>
        <d3p1:Comment>sample string 5</d3p1:Comment>
        <d3p1:Declined>true</d3p1:Declined>
        <d3p1:ReceiptNumber>sample string 2</d3p1:ReceiptNumber>
        <d3p1:SequenceNumber>sample string 4</d3p1:SequenceNumber>
      </d3p1:PremiumDetails>
    </Premiums>
    <UcFund i:nil="true" />
  </KfsTransferRequest>
</ArrayOfKfsTransferRequest>