POST api/BatchManagement/Save

Request Information

URI Parameters

None.

Body Parameters

BatchBindingModel
NameDescriptionTypeAdditional information
BatchId

integer

Required

ItemCount

integer

Required

Range: inclusive between 1 and 2147483647

BatchDate

date

Required

BatchAmount

decimal number

Required

Range: inclusive between 0.01 and 1.79769313486232E+308

ConfirmationAmount

decimal number

Required

Range: inclusive between 0.01 and 1.79769313486232E+308

ConfirmationItemCount

integer

Required

ProcessorUserId

string

None.

SavedDateTime

date

None.

CompletedDateTime

date

None.

RejectDateTime

date

None.

DepositId

integer

None.

CampaignId

integer

None.

RejectDescription

string

String length: inclusive between 0 and 50

HospitalId

integer

None.

ProcessorName

string

None.

BatchDetailBindingModels

Collection of BatchDetailBindingModel

None.

Request Formats

application/json, text/json

Sample:
{
  "batchId": 1,
  "itemCount": 2,
  "batchDate": "2023-01-21T22:26:42.1315683+00:00",
  "batchAmount": 4.0,
  "confirmationAmount": 5.0,
  "confirmationItemCount": 6,
  "processorUserId": "sample string 7",
  "savedDateTime": "2023-01-21T22:26:42.1315683+00:00",
  "completedDateTime": "2023-01-21T22:26:42.1315683+00:00",
  "rejectDateTime": "2023-01-21T22:26:42.1315683+00:00",
  "depositId": 1,
  "campaignId": 9,
  "rejectDescription": "sample string 10",
  "hospitalId": 1,
  "processorName": "sample string 11",
  "batchDetailBindingModels": [
    {
      "batchDetailId": 1,
      "batchId": 2,
      "batchItemType": 1,
      "donorId": 3,
      "donationAmount": 4.0,
      "creditCardType": 1,
      "creditCard": "sample string 5",
      "cvv": "sample string 6",
      "expirationMonth": 1,
      "expirationYear": 1,
      "checkNumber": "sample string 7",
      "transactionResult": "sample string 8",
      "approvedYn": true,
      "itemNumber": 10,
      "chargeFrequency": 11,
      "dayToCharge": 1,
      "monthToTerminate": 1,
      "yearToTerminate": 1,
      "invalidCcyn": true,
      "donorAppealId": 1,
      "giftNotificationId": 13,
      "inHonorId": 14,
      "creditCardPersonName": "sample string 15",
      "campaignId": 16,
      "recurringTransactionId": 1,
      "friendsPersonId": 1,
      "eventName": "sample string 17",
      "ackType": 1,
      "donationDate": "2023-01-21T22:26:42.1315683+00:00",
      "hospitalId": 18,
      "firstName": "sample string 19",
      "lastName": "sample string 20",
      "companyName": "sample string 21",
      "inHonorModel": {
        "inHonorId": 1,
        "donorId": 2,
        "campaignId": 3,
        "inHonorOf": true,
        "inHonorName": "sample string 5",
        "donorTransactionId": 1
      },
      "giftNotificationModel": {
        "giftNotificationId": 1,
        "donorId": 2,
        "campaignId": 3,
        "notifyName": "sample string 4",
        "address1": "sample string 5",
        "address2": "sample string 6",
        "city": "sample string 7",
        "stateId": 1,
        "state": "sample string 8",
        "postalCode": "sample string 9",
        "campaignName": "sample string 10",
        "donorTransactionId": 1
      },
      "bankAccountNumber": "sample string 22",
      "abaNumber": "sample string 23",
      "bankName": "sample string 24",
      "checkingAccountYn": true,
      "nonce": "sample string 25"
    },
    {
      "batchDetailId": 1,
      "batchId": 2,
      "batchItemType": 1,
      "donorId": 3,
      "donationAmount": 4.0,
      "creditCardType": 1,
      "creditCard": "sample string 5",
      "cvv": "sample string 6",
      "expirationMonth": 1,
      "expirationYear": 1,
      "checkNumber": "sample string 7",
      "transactionResult": "sample string 8",
      "approvedYn": true,
      "itemNumber": 10,
      "chargeFrequency": 11,
      "dayToCharge": 1,
      "monthToTerminate": 1,
      "yearToTerminate": 1,
      "invalidCcyn": true,
      "donorAppealId": 1,
      "giftNotificationId": 13,
      "inHonorId": 14,
      "creditCardPersonName": "sample string 15",
      "campaignId": 16,
      "recurringTransactionId": 1,
      "friendsPersonId": 1,
      "eventName": "sample string 17",
      "ackType": 1,
      "donationDate": "2023-01-21T22:26:42.1315683+00:00",
      "hospitalId": 18,
      "firstName": "sample string 19",
      "lastName": "sample string 20",
      "companyName": "sample string 21",
      "inHonorModel": {
        "inHonorId": 1,
        "donorId": 2,
        "campaignId": 3,
        "inHonorOf": true,
        "inHonorName": "sample string 5",
        "donorTransactionId": 1
      },
      "giftNotificationModel": {
        "giftNotificationId": 1,
        "donorId": 2,
        "campaignId": 3,
        "notifyName": "sample string 4",
        "address1": "sample string 5",
        "address2": "sample string 6",
        "city": "sample string 7",
        "stateId": 1,
        "state": "sample string 8",
        "postalCode": "sample string 9",
        "campaignName": "sample string 10",
        "donorTransactionId": 1
      },
      "bankAccountNumber": "sample string 22",
      "abaNumber": "sample string 23",
      "bankName": "sample string 24",
      "checkingAccountYn": true,
      "nonce": "sample string 25"
    }
  ]
}

application/xml, text/xml

Sample:
<BatchBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMN.DonorNet.V3.Binding.Models">
  <BatchAmount>4</BatchAmount>
  <BatchDate>2023-01-21T22:26:42.1315683+00:00</BatchDate>
  <BatchDetailBindingModels>
    <BatchDetailBindingModel>
      <AbaNumber>sample string 23</AbaNumber>
      <AckType>1</AckType>
      <ApprovedYn>true</ApprovedYn>
      <BankAccountNumber>sample string 22</BankAccountNumber>
      <BankName>sample string 24</BankName>
      <BatchDetailId>1</BatchDetailId>
      <BatchId>2</BatchId>
      <BatchItemType>CreditCard</BatchItemType>
      <CampaignId>16</CampaignId>
      <ChargeFrequency>11</ChargeFrequency>
      <CheckNumber>sample string 7</CheckNumber>
      <CheckingAccountYn>true</CheckingAccountYn>
      <CompanyName>sample string 21</CompanyName>
      <CreditCard>sample string 5</CreditCard>
      <CreditCardPersonName>sample string 15</CreditCardPersonName>
      <CreditCardType>1</CreditCardType>
      <Cvv>sample string 6</Cvv>
      <DayToCharge>1</DayToCharge>
      <DonationAmount>4</DonationAmount>
      <DonationDate>2023-01-21T22:26:42.1315683+00:00</DonationDate>
      <DonorAppealId>1</DonorAppealId>
      <DonorId>3</DonorId>
      <EventName>sample string 17</EventName>
      <ExpirationMonth>1</ExpirationMonth>
      <ExpirationYear>1</ExpirationYear>
      <FirstName>sample string 19</FirstName>
      <FriendsPersonId>1</FriendsPersonId>
      <GiftNotificationId>13</GiftNotificationId>
      <GiftNotificationModel>
        <Address1>sample string 5</Address1>
        <Address2>sample string 6</Address2>
        <CampaignId>3</CampaignId>
        <CampaignName>sample string 10</CampaignName>
        <City>sample string 7</City>
        <DonorId>2</DonorId>
        <DonorTransactionId>1</DonorTransactionId>
        <GiftNotificationId>1</GiftNotificationId>
        <NotifyName>sample string 4</NotifyName>
        <PostalCode>sample string 9</PostalCode>
        <State>sample string 8</State>
        <StateId>1</StateId>
      </GiftNotificationModel>
      <HospitalId>18</HospitalId>
      <InHonorId>14</InHonorId>
      <InHonorModel>
        <CampaignId>3</CampaignId>
        <DonorId>2</DonorId>
        <DonorTransactionId>1</DonorTransactionId>
        <InHonorId>1</InHonorId>
        <InHonorName>sample string 5</InHonorName>
        <InHonorOf>true</InHonorOf>
      </InHonorModel>
      <InvalidCcyn>true</InvalidCcyn>
      <ItemNumber>10</ItemNumber>
      <LastName>sample string 20</LastName>
      <MonthToTerminate>1</MonthToTerminate>
      <Nonce>sample string 25</Nonce>
      <RecurringTransactionId>1</RecurringTransactionId>
      <TransactionResult>sample string 8</TransactionResult>
      <YearToTerminate>1</YearToTerminate>
    </BatchDetailBindingModel>
    <BatchDetailBindingModel>
      <AbaNumber>sample string 23</AbaNumber>
      <AckType>1</AckType>
      <ApprovedYn>true</ApprovedYn>
      <BankAccountNumber>sample string 22</BankAccountNumber>
      <BankName>sample string 24</BankName>
      <BatchDetailId>1</BatchDetailId>
      <BatchId>2</BatchId>
      <BatchItemType>CreditCard</BatchItemType>
      <CampaignId>16</CampaignId>
      <ChargeFrequency>11</ChargeFrequency>
      <CheckNumber>sample string 7</CheckNumber>
      <CheckingAccountYn>true</CheckingAccountYn>
      <CompanyName>sample string 21</CompanyName>
      <CreditCard>sample string 5</CreditCard>
      <CreditCardPersonName>sample string 15</CreditCardPersonName>
      <CreditCardType>1</CreditCardType>
      <Cvv>sample string 6</Cvv>
      <DayToCharge>1</DayToCharge>
      <DonationAmount>4</DonationAmount>
      <DonationDate>2023-01-21T22:26:42.1315683+00:00</DonationDate>
      <DonorAppealId>1</DonorAppealId>
      <DonorId>3</DonorId>
      <EventName>sample string 17</EventName>
      <ExpirationMonth>1</ExpirationMonth>
      <ExpirationYear>1</ExpirationYear>
      <FirstName>sample string 19</FirstName>
      <FriendsPersonId>1</FriendsPersonId>
      <GiftNotificationId>13</GiftNotificationId>
      <GiftNotificationModel>
        <Address1>sample string 5</Address1>
        <Address2>sample string 6</Address2>
        <CampaignId>3</CampaignId>
        <CampaignName>sample string 10</CampaignName>
        <City>sample string 7</City>
        <DonorId>2</DonorId>
        <DonorTransactionId>1</DonorTransactionId>
        <GiftNotificationId>1</GiftNotificationId>
        <NotifyName>sample string 4</NotifyName>
        <PostalCode>sample string 9</PostalCode>
        <State>sample string 8</State>
        <StateId>1</StateId>
      </GiftNotificationModel>
      <HospitalId>18</HospitalId>
      <InHonorId>14</InHonorId>
      <InHonorModel>
        <CampaignId>3</CampaignId>
        <DonorId>2</DonorId>
        <DonorTransactionId>1</DonorTransactionId>
        <InHonorId>1</InHonorId>
        <InHonorName>sample string 5</InHonorName>
        <InHonorOf>true</InHonorOf>
      </InHonorModel>
      <InvalidCcyn>true</InvalidCcyn>
      <ItemNumber>10</ItemNumber>
      <LastName>sample string 20</LastName>
      <MonthToTerminate>1</MonthToTerminate>
      <Nonce>sample string 25</Nonce>
      <RecurringTransactionId>1</RecurringTransactionId>
      <TransactionResult>sample string 8</TransactionResult>
      <YearToTerminate>1</YearToTerminate>
    </BatchDetailBindingModel>
  </BatchDetailBindingModels>
  <BatchId>1</BatchId>
  <CampaignId>9</CampaignId>
  <CompletedDateTime>2023-01-21T22:26:42.1315683+00:00</CompletedDateTime>
  <ConfirmationAmount>5</ConfirmationAmount>
  <ConfirmationItemCount>6</ConfirmationItemCount>
  <DepositId>1</DepositId>
  <HospitalId>1</HospitalId>
  <ItemCount>2</ItemCount>
  <ProcessorName>sample string 11</ProcessorName>
  <ProcessorUserId>sample string 7</ProcessorUserId>
  <RejectDateTime>2023-01-21T22:26:42.1315683+00:00</RejectDateTime>
  <RejectDescription>sample string 10</RejectDescription>
  <SavedDateTime>2023-01-21T22:26:42.1315683+00:00</SavedDateTime>
</BatchBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.