POST api/{context}/pledge/Create

Create a new pledge in Aegis CRM.
If Aegis CRM is responsible for handling recurring payments, and you pass AutoPayment = true, this will create a new profile at
the payment gateway. Make sure that you set the StartDate and DayToCharge appropriately because they will be used to determine
the first payment. If Aegis CRM does not handle the recurring charges, this end point will simply record the information provided.
Due to PCI Compliance, we cannot store full credit card details, so the Number will automatically be masked.

Request Information

ParameterDescriptionAdditional information
pledgeModel 

                
                            
Define this parameter in the request body.

                		
            

    

            
Requirements




    
    
NumberNotes

    
    
        

            #1
            
The Partner, Appeal, and Pledge Program must already exist in Aegis CRM.

        

        

            #2
            
Partner Id, Pledge Amount, Payment Type, Start Date, and Pledge Type are all required fields.

        

        

            #3
            
Auto-debiting pledges must have a Pledge Program.

        

    

            
Special Field Notes



    
    
Field NameNotes

    
    
        

            BatchType
            
Set the batch type to be used for this transaction, defaults to 'Web'

        

        

            Channel
            
Set the Channel (E.G.: CallCenter, Web, Mail, Phone, Walk In, etc.)

        

        

            DayToCharge
            
Represents the day of the month that it will charge.

        

        

            Frequency
            
Valid options include: Once, Daily, Weekly, Monthly, Bimonthly, Quarterly, Annually, Semiannually, Semimonthly

        

        

            ID
            
Represents the unique identifier for this pledge.  On Create/POST Auto-generated by the Aegis CRM application, any values you provide will be ignored. On Save/PUT, use only those provided in GET results.

        

        

            PaymentSubType
            
For CreditCard, valid options are: Visa, MasterCard, Discover, or American Express. For EFT, valid options are: Checking or Savings 

        

        

            PaymentTokenID
            
Generated by the Aegis CRM application when a new recurring profile is created.  Any values you pass will be ignored. 

        

        

            PaymentType
            
Valid options include: CreditCard, ElectronicFundsTransfer, Check, Cash, or {Some Other Custom Type That is Meaningless to Aegis CRM} 

        

        

            PledgeType
            
Valid options include: OneTime, OpenEnded, FixedPeriod, GoalBased

        

        

            StartDate
            
Represents the first day the pledge is due.

        

    

            
Request body formats




        
application/json, text/json

        

            Sample:

{
  "ID": "762c0022-13e4-487f-8589-32fc8098c69f",
  "PartnerID": "sample string 1",
  "PledgeAmount": 1.0,
  "DatePledged": "2024-04-26T12:09:59.7717637-06:00",
  "AppealCode": "sample string 2",
  "StartDate": "2024-04-26T12:09:59.7717637-06:00",
  "DayToCharge": 1,
  "PledgeType": "sample string 3",
  "Frequency": "sample string 4",
  "Installments": 1,
  "PledgeProgramName": "sample string 5",
  "BatchType": "sample string 6",
  "Active": true,
  "AutoPayment": true,
  "PaymentType": "sample string 9",
  "PaymentSubType": "sample string 10",
  "PaymentBank": "sample string 11",
  "PaymentNumber": "sample string 13",
  "PaymentExtraID": "sample string 14",
  "PaymentExpDate": "2024-04-26T12:09:59.7717637-06:00",
  "PaymentFirstName": "sample string 15",
  "PaymentMiddleName": "sample string 16",
  "PaymentLastName": "sample string 17",
  "PaymentAddress1": "sample string 18",
  "PaymentAddress2": "sample string 19",
  "PaymentCity": "sample string 20",
  "PaymentStateProvince": "sample string 21",
  "PaymentPostalCode": "sample string 22",
  "PaymentCountry": "sample string 23",
  "PaymentTokenID": "sample string 24",
  "PendingProfileUpdate": true,
  "Note": "sample string 26",
  "Channel": "sample string 27"
}


        

        
application/xml, text/xml

        

            Sample:

<PledgeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <Active>true</Active>
  <AppealCode>sample string 2</AppealCode>
  <AutoPayment>true</AutoPayment>
  <BatchType>sample string 6</BatchType>
  <Channel>sample string 27</Channel>
  <DatePledged>2024-04-26T12:09:59.7717637-06:00</DatePledged>
  <DayToCharge>1</DayToCharge>
  <Frequency>sample string 4</Frequency>
  <ID>762c0022-13e4-487f-8589-32fc8098c69f</ID>
  <Installments>1</Installments>
  <Note>sample string 26</Note>
  <PartnerID>sample string 1</PartnerID>
  <PaymentAddress1>sample string 18</PaymentAddress1>
  <PaymentAddress2>sample string 19</PaymentAddress2>
  <PaymentBank>sample string 11</PaymentBank>
  <PaymentCity>sample string 20</PaymentCity>
  <PaymentCountry>sample string 23</PaymentCountry>
  <PaymentExpDate>2024-04-26T12:09:59.7717637-06:00</PaymentExpDate>
  <PaymentExtraID>sample string 14</PaymentExtraID>
  <PaymentFirstName>sample string 15</PaymentFirstName>
  <PaymentLastName>sample string 17</PaymentLastName>
  <PaymentMiddleName>sample string 16</PaymentMiddleName>
  <PaymentNumber>sample string 13</PaymentNumber>
  <PaymentPostalCode>sample string 22</PaymentPostalCode>
  <PaymentStateProvince>sample string 21</PaymentStateProvince>
  <PaymentSubType>sample string 10</PaymentSubType>
  <PaymentTokenID>sample string 24</PaymentTokenID>
  <PaymentType>sample string 9</PaymentType>
  <PendingProfileUpdate>true</PendingProfileUpdate>
  <PledgeAmount>1</PledgeAmount>
  <PledgeProgramName>sample string 5</PledgeProgramName>
  <PledgeType>sample string 3</PledgeType>
  <StartDate>2024-04-26T12:09:59.7717637-06:00</StartDate>
  <UnmaskedPaymentNumber>sample string 13</UnmaskedPaymentNumber>
</PledgeModel>