POST api/v1/Donation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Organization	string	Required
ID	string	None.
Account	string	None.
DonorDetail	DonorV1	None.
ExternalReference	string	None.
ExternalOrigin	string	None.
Date	date	None.
UTCDate	date	None.
TimeZone	string	None.
Total	decimal number	Required
Currency	string	None.
ConvRate	decimal number	None.
Program	string	None.
MediaOutlet	string	None.
Dialed	string	None.
Method	string	None.
Campaign	string	None.
DonationCode	string	None.
Fund	string	None.
ShippingAddress	PostalAddressV1	None.
MailingAddress	PostalAddressV1	None.
Items	Collection of DonationLineItem	None.
Payments	Collection of DonationPayment	None.
RecurringDonations	Collection of DonationRecurrence	None.

Request Formats

application/json, text/json

Sample:

{
  "Organization": "sample string 1",
  "ID": "sample string 2",
  "Account": "sample string 3",
  "DonorDetail": {
    "ID": "sample string 1",
    "ExternalReference": "sample string 2",
    "ExternalOrigin": "sample string 3",
    "Source": "sample string 4",
    "DateAdd": "2025-09-04T15:06:11.970",
    "DateAddUTC": "sample string 6",
    "NameLast": "sample string 7",
    "NameFirst": "sample string 8",
    "NameMiddle": "sample string 9",
    "NameTitle": "sample string 10",
    "NameSuffix": "sample string 11",
    "Salutation": "sample string 12",
    "Company": "sample string 13",
    "DonorType": "sample string 14",
    "DonorAddress": {
      "RecipientName": "sample string 1",
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "Line3": "sample string 4",
      "City": "sample string 5",
      "County": "sample string 6",
      "StatePR": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9"
    },
    "SecondaryAddresses": [
      {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "County": "sample string 6",
        "StatePR": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9"
      },
      {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "County": "sample string 6",
        "StatePR": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9"
      }
    ],
    "Email": "sample string 15",
    "SecondaryEmails": [
      "sample string 1",
      "sample string 2"
    ],
    "Phone": "sample string 16",
    "SecondaryPhone": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "ExternalReference": "sample string 4",
  "ExternalOrigin": "sample string 5",
  "Date": "2025-09-04T15:06:11.970",
  "UTCDate": "2025-09-04T15:06:11.970",
  "TimeZone": "sample string 8",
  "Total": 9.0,
  "Currency": "sample string 10",
  "ConvRate": 11.0,
  "Program": "sample string 12",
  "MediaOutlet": "sample string 13",
  "Dialed": "sample string 14",
  "Method": "sample string 15",
  "Campaign": "sample string 16",
  "DonationCode": "sample string 17",
  "Fund": "sample string 18",
  "ShippingAddress": {
    "RecipientName": "sample string 1",
    "Line1": "sample string 2",
    "Line2": "sample string 3",
    "Line3": "sample string 4",
    "City": "sample string 5",
    "County": "sample string 6",
    "StatePR": "sample string 7",
    "PostalCode": "sample string 8",
    "Country": "sample string 9"
  },
  "MailingAddress": {
    "RecipientName": "sample string 1",
    "Line1": "sample string 2",
    "Line2": "sample string 3",
    "Line3": "sample string 4",
    "City": "sample string 5",
    "County": "sample string 6",
    "StatePR": "sample string 7",
    "PostalCode": "sample string 8",
    "Country": "sample string 9"
  },
  "Items": [
    {
      "Line": "sample string 1",
      "ProdCode": "sample string 2",
      "ExternalProdCode": "sample string 3",
      "ProdDescription": "sample string 4",
      "Quantity": 5,
      "UnitPrice": 6.0,
      "ExtPrice": 7.0,
      "UnitFMV": 8.0,
      "ExtFMV": 9.0
    },
    {
      "Line": "sample string 1",
      "ProdCode": "sample string 2",
      "ExternalProdCode": "sample string 3",
      "ProdDescription": "sample string 4",
      "Quantity": 5,
      "UnitPrice": 6.0,
      "ExtPrice": 7.0,
      "UnitFMV": 8.0,
      "ExtFMV": 9.0
    }
  ],
  "Payments": [
    {
      "PayIndex": 1,
      "PayMethod": "sample string 2",
      "PayStatus": "sample string 3",
      "PayAmount": "sample string 4",
      "Currency": "sample string 5",
      "ConvRate": 6.0,
      "PayorName": "sample string 7",
      "PayorAddress": {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "County": "sample string 6",
        "StatePR": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9"
      },
      "ProfileToken": "sample string 8",
      "Gateway": "sample string 9",
      "CreditCardType": "sample string 10",
      "CreditCardNumber": "sample string 11",
      "CreditCardExpiration": "sample string 12",
      "CreditCardSecurity": "sample string 13",
      "AuthorizationCode": "sample string 14",
      "AuthMessage": "sample string 15",
      "AuthDate": "sample string 16",
      "CheckRouting": "sample string 17",
      "CheckAccount": "sample string 18"
    },
    {
      "PayIndex": 1,
      "PayMethod": "sample string 2",
      "PayStatus": "sample string 3",
      "PayAmount": "sample string 4",
      "Currency": "sample string 5",
      "ConvRate": 6.0,
      "PayorName": "sample string 7",
      "PayorAddress": {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "County": "sample string 6",
        "StatePR": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9"
      },
      "ProfileToken": "sample string 8",
      "Gateway": "sample string 9",
      "CreditCardType": "sample string 10",
      "CreditCardNumber": "sample string 11",
      "CreditCardExpiration": "sample string 12",
      "CreditCardSecurity": "sample string 13",
      "AuthorizationCode": "sample string 14",
      "AuthMessage": "sample string 15",
      "AuthDate": "sample string 16",
      "CheckRouting": "sample string 17",
      "CheckAccount": "sample string 18"
    }
  ],
  "RecurringDonations": [
    {
      "RecurrenceIndex": 1,
      "Start": "2025-09-04T15:06:11.970",
      "End": "2025-09-04T15:06:11.970",
      "Interval": "sample string 4",
      "PayIndex": 5,
      "Amount": 6.0,
      "DonationCode": "sample string 7",
      "Fund": "sample string 8",
      "Section": "sample string 9"
    },
    {
      "RecurrenceIndex": 1,
      "Start": "2025-09-04T15:06:11.970",
      "End": "2025-09-04T15:06:11.970",
      "Interval": "sample string 4",
      "PayIndex": 5,
      "Amount": 6.0,
      "DonationCode": "sample string 7",
      "Fund": "sample string 8",
      "Section": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<Donation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Account>sample string 3</Account>
  <Campaign>sample string 16</Campaign>
  <ConvRate>11</ConvRate>
  <Currency>sample string 10</Currency>
  <Date>2025-09-04T15:06:11.9709474+00:00</Date>
  <Dialed>sample string 14</Dialed>
  <DonationCode>sample string 17</DonationCode>
  <DonorDetail>
    <Company>sample string 13</Company>
    <DateAdd>2025-09-04T15:06:11.9709474+00:00</DateAdd>
    <DateAddUTC>sample string 6</DateAddUTC>
    <DonorAddress>
      <City>sample string 5</City>
      <Country>sample string 9</Country>
      <County>sample string 6</County>
      <Line1>sample string 2</Line1>
      <Line2>sample string 3</Line2>
      <Line3>sample string 4</Line3>
      <PostalCode>sample string 8</PostalCode>
      <RecipientName>sample string 1</RecipientName>
      <StatePR>sample string 7</StatePR>
    </DonorAddress>
    <DonorType>sample string 14</DonorType>
    <Email>sample string 15</Email>
    <ExternalOrigin>sample string 3</ExternalOrigin>
    <ExternalReference>sample string 2</ExternalReference>
    <ID>sample string 1</ID>
    <NameFirst>sample string 8</NameFirst>
    <NameLast>sample string 7</NameLast>
    <NameMiddle>sample string 9</NameMiddle>
    <NameSuffix>sample string 11</NameSuffix>
    <NameTitle>sample string 10</NameTitle>
    <Phone>sample string 16</Phone>
    <Salutation>sample string 12</Salutation>
    <SecondaryAddresses>
      <PostalAddressV1>
        <City>sample string 5</City>
        <Country>sample string 9</Country>
        <County>sample string 6</County>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 8</PostalCode>
        <RecipientName>sample string 1</RecipientName>
        <StatePR>sample string 7</StatePR>
      </PostalAddressV1>
      <PostalAddressV1>
        <City>sample string 5</City>
        <Country>sample string 9</Country>
        <County>sample string 6</County>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 8</PostalCode>
        <RecipientName>sample string 1</RecipientName>
        <StatePR>sample string 7</StatePR>
      </PostalAddressV1>
    </SecondaryAddresses>
    <SecondaryEmails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SecondaryEmails>
    <SecondaryPhone xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SecondaryPhone>
    <Source>sample string 4</Source>
  </DonorDetail>
  <ExternalOrigin>sample string 5</ExternalOrigin>
  <ExternalReference>sample string 4</ExternalReference>
  <Fund>sample string 18</Fund>
  <ID>sample string 2</ID>
  <Items>
    <DonationLineItem>
      <ExtFMV>9</ExtFMV>
      <ExtPrice>7</ExtPrice>
      <ExternalProdCode>sample string 3</ExternalProdCode>
      <Line>sample string 1</Line>
      <ProdCode>sample string 2</ProdCode>
      <ProdDescription>sample string 4</ProdDescription>
      <Quantity>5</Quantity>
      <UnitFMV>8</UnitFMV>
      <UnitPrice>6</UnitPrice>
    </DonationLineItem>
    <DonationLineItem>
      <ExtFMV>9</ExtFMV>
      <ExtPrice>7</ExtPrice>
      <ExternalProdCode>sample string 3</ExternalProdCode>
      <Line>sample string 1</Line>
      <ProdCode>sample string 2</ProdCode>
      <ProdDescription>sample string 4</ProdDescription>
      <Quantity>5</Quantity>
      <UnitFMV>8</UnitFMV>
      <UnitPrice>6</UnitPrice>
    </DonationLineItem>
  </Items>
  <MailingAddress>
    <City>sample string 5</City>
    <Country>sample string 9</Country>
    <County>sample string 6</County>
    <Line1>sample string 2</Line1>
    <Line2>sample string 3</Line2>
    <Line3>sample string 4</Line3>
    <PostalCode>sample string 8</PostalCode>
    <RecipientName>sample string 1</RecipientName>
    <StatePR>sample string 7</StatePR>
  </MailingAddress>
  <MediaOutlet>sample string 13</MediaOutlet>
  <Method>sample string 15</Method>
  <Organization>sample string 1</Organization>
  <Payments>
    <DonationPayment>
      <AuthDate>sample string 16</AuthDate>
      <AuthMessage>sample string 15</AuthMessage>
      <AuthorizationCode>sample string 14</AuthorizationCode>
      <CheckAccount>sample string 18</CheckAccount>
      <CheckRouting>sample string 17</CheckRouting>
      <ConvRate>6</ConvRate>
      <CreditCardExpiration>sample string 12</CreditCardExpiration>
      <CreditCardNumber>sample string 11</CreditCardNumber>
      <CreditCardSecurity>sample string 13</CreditCardSecurity>
      <CreditCardType>sample string 10</CreditCardType>
      <Currency>sample string 5</Currency>
      <Gateway>sample string 9</Gateway>
      <PayAmount>sample string 4</PayAmount>
      <PayIndex>1</PayIndex>
      <PayMethod>sample string 2</PayMethod>
      <PayStatus>sample string 3</PayStatus>
      <PayorAddress>
        <City>sample string 5</City>
        <Country>sample string 9</Country>
        <County>sample string 6</County>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 8</PostalCode>
        <RecipientName>sample string 1</RecipientName>
        <StatePR>sample string 7</StatePR>
      </PayorAddress>
      <PayorName>sample string 7</PayorName>
      <ProfileToken>sample string 8</ProfileToken>
    </DonationPayment>
    <DonationPayment>
      <AuthDate>sample string 16</AuthDate>
      <AuthMessage>sample string 15</AuthMessage>
      <AuthorizationCode>sample string 14</AuthorizationCode>
      <CheckAccount>sample string 18</CheckAccount>
      <CheckRouting>sample string 17</CheckRouting>
      <ConvRate>6</ConvRate>
      <CreditCardExpiration>sample string 12</CreditCardExpiration>
      <CreditCardNumber>sample string 11</CreditCardNumber>
      <CreditCardSecurity>sample string 13</CreditCardSecurity>
      <CreditCardType>sample string 10</CreditCardType>
      <Currency>sample string 5</Currency>
      <Gateway>sample string 9</Gateway>
      <PayAmount>sample string 4</PayAmount>
      <PayIndex>1</PayIndex>
      <PayMethod>sample string 2</PayMethod>
      <PayStatus>sample string 3</PayStatus>
      <PayorAddress>
        <City>sample string 5</City>
        <Country>sample string 9</Country>
        <County>sample string 6</County>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 8</PostalCode>
        <RecipientName>sample string 1</RecipientName>
        <StatePR>sample string 7</StatePR>
      </PayorAddress>
      <PayorName>sample string 7</PayorName>
      <ProfileToken>sample string 8</ProfileToken>
    </DonationPayment>
  </Payments>
  <Program>sample string 12</Program>
  <RecurringDonations>
    <DonationRecurrence>
      <Amount>6</Amount>
      <DonationCode>sample string 7</DonationCode>
      <End>2025-09-04T15:06:11.9709474+00:00</End>
      <Fund>sample string 8</Fund>
      <Interval>sample string 4</Interval>
      <PayIndex>5</PayIndex>
      <RecurrenceIndex>1</RecurrenceIndex>
      <Section>sample string 9</Section>
      <Start>2025-09-04T15:06:11.9709474+00:00</Start>
    </DonationRecurrence>
    <DonationRecurrence>
      <Amount>6</Amount>
      <DonationCode>sample string 7</DonationCode>
      <End>2025-09-04T15:06:11.9709474+00:00</End>
      <Fund>sample string 8</Fund>
      <Interval>sample string 4</Interval>
      <PayIndex>5</PayIndex>
      <RecurrenceIndex>1</RecurrenceIndex>
      <Section>sample string 9</Section>
      <Start>2025-09-04T15:06:11.9709474+00:00</Start>
    </DonationRecurrence>
  </RecurringDonations>
  <ShippingAddress>
    <City>sample string 5</City>
    <Country>sample string 9</Country>
    <County>sample string 6</County>
    <Line1>sample string 2</Line1>
    <Line2>sample string 3</Line2>
    <Line3>sample string 4</Line3>
    <PostalCode>sample string 8</PostalCode>
    <RecipientName>sample string 1</RecipientName>
    <StatePR>sample string 7</StatePR>
  </ShippingAddress>
  <TimeZone>sample string 8</TimeZone>
  <Total>9</Total>
  <UTCDate>2025-09-04T15:06:11.9709474+00:00</UTCDate>
</Donation>

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.