POST api/v1/transaction

Add a new Transaction

Request Information

URI Parameters

None.

Body Parameters

Transaction object that needs to be added

Name	Type	Additional information
BatchCode	string	Required
TransactionDate	date	Required
TransactionStatus	string	Required
TransactionID	string	None.
DonorID	string	Required
ReplacementFor	TransactionReference	None.
ReplacementIssueLetter	boolean	None.
ReversingTransaction	TransactionReference	None.
ReplacementTransaction	TransactionReference	None.
ExternalReference	string	None.
ExternalOrigin	string	None.
References	Collection of Reference	None.
Total	decimal number	Required
Currency	string	None.
ConvRate	decimal number	None.
DepositCode	string	None.
Program	string	None.
MediaOutlet	string	None.
Dialed	string	None.
Donations	Collection of TransactionDonation	None.
Items	Collection of TransactionLineItem	None.
TripPayments	Collection of TransactionTripPayment	None.
Remittances	Collection of TransactionRemittance	None.
RecurringDonations	Collection of TransactionRecurrence	None.
Documents	Collection of TransactionDocuments	None.
LetterCode	string	None.
LetterIssued	date	None.
LastUpdated	date	None.
LastUpdatedBy	string	None.
Created	date	None.
CreatedBy	string	String length: inclusive between 0 and 200
StopLabel	string	String length: inclusive between 0 and 1

Request Formats

application/json, text/json

Sample:

{
  "BatchCode": "sample string 1",
  "TransactionDate": "2025-09-04T15:06:12.205",
  "TransactionStatus": "sample string 3",
  "TransactionID": "sample string 4",
  "DonorID": "sample string 5",
  "ReplacementFor": {
    "TransactionDate": "2025-09-04T15:06:12.205",
    "TransactionID": "sample string 2"
  },
  "ReplacementIssueLetter": true,
  "ReversingTransaction": {
    "TransactionDate": "2025-09-04T15:06:12.205",
    "TransactionID": "sample string 2"
  },
  "ReplacementTransaction": {
    "TransactionDate": "2025-09-04T15:06:12.205",
    "TransactionID": "sample string 2"
  },
  "ExternalReference": "sample string 7",
  "ExternalOrigin": "sample string 8",
  "References": [
    {
      "Type": "sample string 1",
      "Value": "sample string 2",
      "Category": "sample string 3"
    },
    {
      "Type": "sample string 1",
      "Value": "sample string 2",
      "Category": "sample string 3"
    }
  ],
  "Total": 9.0,
  "Currency": "sample string 10",
  "ConvRate": 11.0,
  "DepositCode": "sample string 12",
  "Program": "sample string 13",
  "MediaOutlet": "sample string 14",
  "Dialed": "sample string 15",
  "Donations": [
    {
      "Amount": 1.0,
      "DonationCode": "sample string 2",
      "Fund": "sample string 3",
      "Section": "sample string 4"
    },
    {
      "Amount": 1.0,
      "DonationCode": "sample string 2",
      "Fund": "sample string 3",
      "Section": "sample string 4"
    }
  ],
  "Items": [
    {
      "ProdCode": "sample string 1",
      "LineNumber": 2,
      "Quantity": 3,
      "UnitPrice": 4.0,
      "ExtPrice": 5.0,
      "ShipDate": "2025-09-04T15:06:12.205",
      "ShipTracking": "sample string 7",
      "ShipCarrier": "sample string 8",
      "ShippingAddress": {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "StatePR": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8"
      },
      "Personalization": "sample string 9",
      "IDNumber": "sample string 10",
      "Location": "sample string 11",
      "ExplodedItem": true,
      "ExplodedFromLineNumber": 13,
      "ShipStatus": "sample string 14"
    },
    {
      "ProdCode": "sample string 1",
      "LineNumber": 2,
      "Quantity": 3,
      "UnitPrice": 4.0,
      "ExtPrice": 5.0,
      "ShipDate": "2025-09-04T15:06:12.205",
      "ShipTracking": "sample string 7",
      "ShipCarrier": "sample string 8",
      "ShippingAddress": {
        "RecipientName": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "StatePR": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8"
      },
      "Personalization": "sample string 9",
      "IDNumber": "sample string 10",
      "Location": "sample string 11",
      "ExplodedItem": true,
      "ExplodedFromLineNumber": 13,
      "ShipStatus": "sample string 14"
    }
  ],
  "TripPayments": [
    {
      "PaymentTotal": 1.0,
      "TripNumber": "sample string 2",
      "DonationCode": "sample string 3",
      "Fund": "sample string 4",
      "Section": "sample string 5",
      "Deductible": "sample string 6"
    },
    {
      "PaymentTotal": 1.0,
      "TripNumber": "sample string 2",
      "DonationCode": "sample string 3",
      "Fund": "sample string 4",
      "Section": "sample string 5",
      "Deductible": "sample string 6"
    }
  ],
  "Remittances": [
    {
      "PayMethod": "sample string 1",
      "PayStatus": "sample string 2",
      "PayAmount": 3.0,
      "PayorName": "sample string 4",
      "PayorAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "City": "sample string 4",
        "StatePR": "sample string 5",
        "PostalCode": "sample string 6",
        "Country": "sample string 7"
      },
      "ProfileToken": "sample string 5",
      "Gateway": "sample string 6",
      "CreditCardType": "sample string 7",
      "CreditCardNumber": "sample string 8",
      "CreditCardExpiration": "sample string 9",
      "CreditCardSecurity": "sample string 10",
      "AuthorizationCode": "sample string 11",
      "AuthMessage": "sample string 12",
      "AuthDate": "sample string 13",
      "CheckRouting": "sample string 14",
      "CheckAccount": "sample string 15",
      "CheckNumber": "sample string 16"
    },
    {
      "PayMethod": "sample string 1",
      "PayStatus": "sample string 2",
      "PayAmount": 3.0,
      "PayorName": "sample string 4",
      "PayorAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "City": "sample string 4",
        "StatePR": "sample string 5",
        "PostalCode": "sample string 6",
        "Country": "sample string 7"
      },
      "ProfileToken": "sample string 5",
      "Gateway": "sample string 6",
      "CreditCardType": "sample string 7",
      "CreditCardNumber": "sample string 8",
      "CreditCardExpiration": "sample string 9",
      "CreditCardSecurity": "sample string 10",
      "AuthorizationCode": "sample string 11",
      "AuthMessage": "sample string 12",
      "AuthDate": "sample string 13",
      "CheckRouting": "sample string 14",
      "CheckAccount": "sample string 15",
      "CheckNumber": "sample string 16"
    }
  ],
  "RecurringDonations": [
    {
      "Start": "2025-09-04T15:06:12.205",
      "End": "2025-09-04T15:06:12.205",
      "Interval": "sample string 3",
      "IntervalCount": 4,
      "Amount": 5.0,
      "DonationCode": "sample string 6",
      "Fund": "sample string 7",
      "TransactionID": "sample string 8",
      "TransactionDate": "2025-09-04T15:06:12.205",
      "RecurrenceType": "sample string 10",
      "ExternalReference": "sample string 11",
      "ExternalOrigin": "sample string 12",
      "References": [
        {
          "Type": "sample string 1",
          "Value": "sample string 2",
          "Category": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value": "sample string 2",
          "Category": "sample string 3"
        }
      ]
    },
    {
      "Start": "2025-09-04T15:06:12.205",
      "End": "2025-09-04T15:06:12.205",
      "Interval": "sample string 3",
      "IntervalCount": 4,
      "Amount": 5.0,
      "DonationCode": "sample string 6",
      "Fund": "sample string 7",
      "TransactionID": "sample string 8",
      "TransactionDate": "2025-09-04T15:06:12.205",
      "RecurrenceType": "sample string 10",
      "ExternalReference": "sample string 11",
      "ExternalOrigin": "sample string 12",
      "References": [
        {
          "Type": "sample string 1",
          "Value": "sample string 2",
          "Category": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value": "sample string 2",
          "Category": "sample string 3"
        }
      ]
    }
  ],
  "Documents": [
    {
      "Type": "sample string 1",
      "Reference": "sample string 2"
    },
    {
      "Type": "sample string 1",
      "Reference": "sample string 2"
    }
  ],
  "LetterCode": "sample string 16",
  "LetterIssued": "2025-09-04T15:06:12.205",
  "LastUpdated": "2025-09-04T15:06:12.205",
  "LastUpdatedBy": "sample string 17",
  "Created": "2025-09-04T15:06:12.205",
  "CreatedBy": "sample string 18",
  "StopLabel": "sample string 19"
}

application/xml, text/xml

Sample:

<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <BatchCode>sample string 1</BatchCode>
  <ConvRate>11</ConvRate>
  <Created>2025-09-04T15:06:12.2053245+00:00</Created>
  <CreatedBy>sample string 18</CreatedBy>
  <Currency>sample string 10</Currency>
  <DepositCode>sample string 12</DepositCode>
  <Dialed>sample string 15</Dialed>
  <Documents>
    <TransactionDocuments>
      <Reference>sample string 2</Reference>
      <Type>sample string 1</Type>
    </TransactionDocuments>
    <TransactionDocuments>
      <Reference>sample string 2</Reference>
      <Type>sample string 1</Type>
    </TransactionDocuments>
  </Documents>
  <Donations>
    <TransactionDonation>
      <Amount>1</Amount>
      <DonationCode>sample string 2</DonationCode>
      <Fund>sample string 3</Fund>
      <Section>sample string 4</Section>
    </TransactionDonation>
    <TransactionDonation>
      <Amount>1</Amount>
      <DonationCode>sample string 2</DonationCode>
      <Fund>sample string 3</Fund>
      <Section>sample string 4</Section>
    </TransactionDonation>
  </Donations>
  <DonorID>sample string 5</DonorID>
  <ExternalOrigin>sample string 8</ExternalOrigin>
  <ExternalReference>sample string 7</ExternalReference>
  <Items>
    <TransactionLineItem>
      <ExplodedFromLineNumber>13</ExplodedFromLineNumber>
      <ExplodedItem>true</ExplodedItem>
      <ExtPrice>5</ExtPrice>
      <IDNumber>sample string 10</IDNumber>
      <LineNumber>2</LineNumber>
      <Location>sample string 11</Location>
      <Personalization>sample string 9</Personalization>
      <ProdCode>sample string 1</ProdCode>
      <Quantity>3</Quantity>
      <ShipCarrier>sample string 8</ShipCarrier>
      <ShipDate>2025-09-04T15:06:12.2053245+00:00</ShipDate>
      <ShipStatus>sample string 14</ShipStatus>
      <ShipTracking>sample string 7</ShipTracking>
      <ShippingAddress>
        <City>sample string 5</City>
        <Country>sample string 8</Country>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 7</PostalCode>
        <StatePR>sample string 6</StatePR>
        <RecipientName>sample string 1</RecipientName>
      </ShippingAddress>
      <UnitPrice>4</UnitPrice>
    </TransactionLineItem>
    <TransactionLineItem>
      <ExplodedFromLineNumber>13</ExplodedFromLineNumber>
      <ExplodedItem>true</ExplodedItem>
      <ExtPrice>5</ExtPrice>
      <IDNumber>sample string 10</IDNumber>
      <LineNumber>2</LineNumber>
      <Location>sample string 11</Location>
      <Personalization>sample string 9</Personalization>
      <ProdCode>sample string 1</ProdCode>
      <Quantity>3</Quantity>
      <ShipCarrier>sample string 8</ShipCarrier>
      <ShipDate>2025-09-04T15:06:12.2053245+00:00</ShipDate>
      <ShipStatus>sample string 14</ShipStatus>
      <ShipTracking>sample string 7</ShipTracking>
      <ShippingAddress>
        <City>sample string 5</City>
        <Country>sample string 8</Country>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <PostalCode>sample string 7</PostalCode>
        <StatePR>sample string 6</StatePR>
        <RecipientName>sample string 1</RecipientName>
      </ShippingAddress>
      <UnitPrice>4</UnitPrice>
    </TransactionLineItem>
  </Items>
  <LastUpdated>2025-09-04T15:06:12.2053245+00:00</LastUpdated>
  <LastUpdatedBy>sample string 17</LastUpdatedBy>
  <LetterCode>sample string 16</LetterCode>
  <LetterIssued>2025-09-04T15:06:12.2053245+00:00</LetterIssued>
  <MediaOutlet>sample string 14</MediaOutlet>
  <Program>sample string 13</Program>
  <RecurringDonations>
    <TransactionRecurrence>
      <Amount>5</Amount>
      <DonationCode>sample string 6</DonationCode>
      <End>2025-09-04T15:06:12.2053245+00:00</End>
      <ExternalOrigin>sample string 12</ExternalOrigin>
      <ExternalReference>sample string 11</ExternalReference>
      <Fund>sample string 7</Fund>
      <Interval>sample string 3</Interval>
      <IntervalCount>4</IntervalCount>
      <RecurrenceType>sample string 10</RecurrenceType>
      <References>
        <Reference>
          <Category>sample string 3</Category>
          <Type>sample string 1</Type>
          <Value>sample string 2</Value>
        </Reference>
        <Reference>
          <Category>sample string 3</Category>
          <Type>sample string 1</Type>
          <Value>sample string 2</Value>
        </Reference>
      </References>
      <Start>2025-09-04T15:06:12.2053245+00:00</Start>
      <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
      <TransactionID>sample string 8</TransactionID>
    </TransactionRecurrence>
    <TransactionRecurrence>
      <Amount>5</Amount>
      <DonationCode>sample string 6</DonationCode>
      <End>2025-09-04T15:06:12.2053245+00:00</End>
      <ExternalOrigin>sample string 12</ExternalOrigin>
      <ExternalReference>sample string 11</ExternalReference>
      <Fund>sample string 7</Fund>
      <Interval>sample string 3</Interval>
      <IntervalCount>4</IntervalCount>
      <RecurrenceType>sample string 10</RecurrenceType>
      <References>
        <Reference>
          <Category>sample string 3</Category>
          <Type>sample string 1</Type>
          <Value>sample string 2</Value>
        </Reference>
        <Reference>
          <Category>sample string 3</Category>
          <Type>sample string 1</Type>
          <Value>sample string 2</Value>
        </Reference>
      </References>
      <Start>2025-09-04T15:06:12.2053245+00:00</Start>
      <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
      <TransactionID>sample string 8</TransactionID>
    </TransactionRecurrence>
  </RecurringDonations>
  <References>
    <Reference>
      <Category>sample string 3</Category>
      <Type>sample string 1</Type>
      <Value>sample string 2</Value>
    </Reference>
    <Reference>
      <Category>sample string 3</Category>
      <Type>sample string 1</Type>
      <Value>sample string 2</Value>
    </Reference>
  </References>
  <Remittances>
    <TransactionRemittance>
      <AuthDate>sample string 13</AuthDate>
      <AuthMessage>sample string 12</AuthMessage>
      <AuthorizationCode>sample string 11</AuthorizationCode>
      <CheckAccount>sample string 15</CheckAccount>
      <CheckNumber>sample string 16</CheckNumber>
      <CheckRouting>sample string 14</CheckRouting>
      <CreditCardExpiration>sample string 9</CreditCardExpiration>
      <CreditCardNumber>sample string 8</CreditCardNumber>
      <CreditCardSecurity>sample string 10</CreditCardSecurity>
      <CreditCardType>sample string 7</CreditCardType>
      <Gateway>sample string 6</Gateway>
      <PayAmount>3</PayAmount>
      <PayMethod>sample string 1</PayMethod>
      <PayStatus>sample string 2</PayStatus>
      <PayorAddress>
        <City>sample string 4</City>
        <Country>sample string 7</Country>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Line3>sample string 3</Line3>
        <PostalCode>sample string 6</PostalCode>
        <StatePR>sample string 5</StatePR>
      </PayorAddress>
      <PayorName>sample string 4</PayorName>
      <ProfileToken>sample string 5</ProfileToken>
    </TransactionRemittance>
    <TransactionRemittance>
      <AuthDate>sample string 13</AuthDate>
      <AuthMessage>sample string 12</AuthMessage>
      <AuthorizationCode>sample string 11</AuthorizationCode>
      <CheckAccount>sample string 15</CheckAccount>
      <CheckNumber>sample string 16</CheckNumber>
      <CheckRouting>sample string 14</CheckRouting>
      <CreditCardExpiration>sample string 9</CreditCardExpiration>
      <CreditCardNumber>sample string 8</CreditCardNumber>
      <CreditCardSecurity>sample string 10</CreditCardSecurity>
      <CreditCardType>sample string 7</CreditCardType>
      <Gateway>sample string 6</Gateway>
      <PayAmount>3</PayAmount>
      <PayMethod>sample string 1</PayMethod>
      <PayStatus>sample string 2</PayStatus>
      <PayorAddress>
        <City>sample string 4</City>
        <Country>sample string 7</Country>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Line3>sample string 3</Line3>
        <PostalCode>sample string 6</PostalCode>
        <StatePR>sample string 5</StatePR>
      </PayorAddress>
      <PayorName>sample string 4</PayorName>
      <ProfileToken>sample string 5</ProfileToken>
    </TransactionRemittance>
  </Remittances>
  <ReplacementFor>
    <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
    <TransactionID>sample string 2</TransactionID>
  </ReplacementFor>
  <ReplacementIssueLetter>true</ReplacementIssueLetter>
  <ReplacementTransaction>
    <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
    <TransactionID>sample string 2</TransactionID>
  </ReplacementTransaction>
  <ReversingTransaction>
    <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
    <TransactionID>sample string 2</TransactionID>
  </ReversingTransaction>
  <StopLabel>sample string 19</StopLabel>
  <Total>9</Total>
  <TransactionDate>2025-09-04T15:06:12.2053245+00:00</TransactionDate>
  <TransactionID>sample string 4</TransactionID>
  <TransactionStatus>sample string 3</TransactionStatus>
  <TripPayments>
    <TransactionTripPayment>
      <Deductible>sample string 6</Deductible>
      <DonationCode>sample string 3</DonationCode>
      <Fund>sample string 4</Fund>
      <PaymentTotal>1</PaymentTotal>
      <Section>sample string 5</Section>
      <TripNumber>sample string 2</TripNumber>
    </TransactionTripPayment>
    <TransactionTripPayment>
      <Deductible>sample string 6</Deductible>
      <DonationCode>sample string 3</DonationCode>
      <Fund>sample string 4</Fund>
      <PaymentTotal>1</PaymentTotal>
      <Section>sample string 5</Section>
      <TripNumber>sample string 2</TripNumber>
    </TransactionTripPayment>
  </TripPayments>
</Transaction>

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.