POST api/v1/recurrence

Add Recurrence

Request Information

URI Parameters

None.

Body Parameters

Recurrence object that needs to be added

Name	Type	Additional information
DonorID	string	None.
Remittances	Collection of TransactionRemittance	None.
Currency	string	None.
ParentTransactionID	string	None.
ParentTransactionDate	date	None.
LastUpdated	date	None.
LastUpdatedBy	string	None.
Created	date	None.
CreatedBy	string	String length: inclusive between 0 and 200
Start	date	None.
End	date	None.
Interval	string	None.
IntervalCount	integer	None.
Amount	decimal number	None.
DonationCode	string	None.
Fund	string	None.
TransactionID	string	None.
TransactionDate	date	None.
RecurrenceType	string	None.
ExternalReference	string	None.
ExternalOrigin	string	None.
References	Collection of Reference	None.

Request Formats

application/json, text/json

Sample:

{
  "DonorID": "sample string 1",
  "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"
    }
  ],
  "Currency": "sample string 2",
  "ParentTransactionID": "sample string 3",
  "ParentTransactionDate": "2025-09-04T15:05:24.526",
  "LastUpdated": "2025-09-04T15:05:24.526",
  "LastUpdatedBy": "sample string 5",
  "Created": "2025-09-04T15:05:24.526",
  "CreatedBy": "sample string 6",
  "Start": "2025-09-04T15:05:24.526",
  "End": "2025-09-04T15:05:24.526",
  "Interval": "sample string 9",
  "IntervalCount": 10,
  "Amount": 11.0,
  "DonationCode": "sample string 12",
  "Fund": "sample string 13",
  "TransactionID": "sample string 14",
  "TransactionDate": "2025-09-04T15:05:24.526",
  "RecurrenceType": "sample string 16",
  "ExternalReference": "sample string 17",
  "ExternalOrigin": "sample string 18",
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<Recurrence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Amount>11</Amount>
  <DonationCode>sample string 12</DonationCode>
  <End>2025-09-04T15:05:24.5265846+00:00</End>
  <ExternalOrigin>sample string 18</ExternalOrigin>
  <ExternalReference>sample string 17</ExternalReference>
  <Fund>sample string 13</Fund>
  <Interval>sample string 9</Interval>
  <IntervalCount>10</IntervalCount>
  <RecurrenceType>sample string 16</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:05:24.5265846+00:00</Start>
  <TransactionDate>2025-09-04T15:05:24.5265846+00:00</TransactionDate>
  <TransactionID>sample string 14</TransactionID>
  <Created>2025-09-04T15:05:24.5265846+00:00</Created>
  <CreatedBy>sample string 6</CreatedBy>
  <Currency>sample string 2</Currency>
  <DonorID>sample string 1</DonorID>
  <LastUpdated>2025-09-04T15:05:24.5265846+00:00</LastUpdated>
  <LastUpdatedBy>sample string 5</LastUpdatedBy>
  <ParentTransactionDate>2025-09-04T15:05:24.5265846+00:00</ParentTransactionDate>
  <ParentTransactionID>sample string 3</ParentTransactionID>
  <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>
</Recurrence>

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.