POST api/Lockbox?runDate={runDate}&shortageAmount={shortageAmount}&uploadToKfs={uploadToKfs}

Request Information

URI Parameters

Name	Type	Additional information
runDate	date	Required
shortageAmount	decimal number	Required
uploadToKfs	boolean	Default value is True

Body Parameters

Collection of BankTransferRequest

Name	Type	Additional information
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.

Request Formats

application/json, text/json, text/html

Sample:

[
  {
    "donorName": "sample string 1",
    "amount": 2.0,
    "allocationCode": "sample string 3",
    "departmentCode": "sample string 4",
    "agency": "sample string 5",
    "transactionId": "sample string 6",
    "kfsKey": "sample string 7",
    "authCode": "sample string 8",
    "authorizedAt": "2025-04-29T06:09:41.9028086-07:00",
    "paymentType": 0,
    "merchantId": "sample string 10"
  },
  {
    "donorName": "sample string 1",
    "amount": 2.0,
    "allocationCode": "sample string 3",
    "departmentCode": "sample string 4",
    "agency": "sample string 5",
    "transactionId": "sample string 6",
    "kfsKey": "sample string 7",
    "authCode": "sample string 8",
    "authorizedAt": "2025-04-29T06:09:41.9028086-07:00",
    "paymentType": 0,
    "merchantId": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBankTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GivingService.Models">
  <BankTransferRequest>
    <Agency>sample string 5</Agency>
    <AllocationCode>sample string 3</AllocationCode>
    <Amount>2</Amount>
    <AuthCode>sample string 8</AuthCode>
    <AuthorizedAt>2025-04-29T06:09:41.9028086-07:00</AuthorizedAt>
    <DepartmentCode>sample string 4</DepartmentCode>
    <DonorName>sample string 1</DonorName>
    <KfsKey>sample string 7</KfsKey>
    <MerchantId>sample string 10</MerchantId>
    <PaymentType>Check</PaymentType>
    <TransactionId>sample string 6</TransactionId>
  </BankTransferRequest>
  <BankTransferRequest>
    <Agency>sample string 5</Agency>
    <AllocationCode>sample string 3</AllocationCode>
    <Amount>2</Amount>
    <AuthCode>sample string 8</AuthCode>
    <AuthorizedAt>2025-04-29T06:09:41.9028086-07:00</AuthorizedAt>
    <DepartmentCode>sample string 4</DepartmentCode>
    <DonorName>sample string 1</DonorName>
    <KfsKey>sample string 7</KfsKey>
    <MerchantId>sample string 10</MerchantId>
    <PaymentType>Check</PaymentType>
    <TransactionId>sample string 6</TransactionId>
  </BankTransferRequest>
</ArrayOfBankTransferRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.