POST api/Pledge

Change some detail of a pledge

Request Information

URI Parameters

None.

Body Parameters

The data needed to change

Name	Description	Type	Additional information
CompanyId	1 for klove, 2 for air1	integer	None.
ChangePledgeAmount	Set to proper values to change a pledge amount	ChangePledgeAmount	None.
ChangePledgeAutoBillingDay	Set to proper values to change the billing day of the month on a pledge	ChangePledgeAutoBillingDay	None.
ChangePledgeAutoPayment	Set to proper values to change the auto payment data for a pledge	ChangePledgeAutoPayment	None.
PayOnPledge	Set to proper values to pay on a pledge	PayOnPledge	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "ChangePledgeAmount": {
    "Id": 1,
    "Amount": 2.0
  },
  "ChangePledgeAutoBillingDay": {
    "DayOfMonth": 64
  },
  "ChangePledgeAutoPayment": {
    "BillingAddress": {
      "SecureSystemAddressId": 1,
      "AcceptAddress": true,
      "Id": 2,
      "AccountId": 3,
      "Line1": "sample string 4",
      "Line2": "sample string 5",
      "Line3": "sample string 6",
      "Line4": "sample string 7",
      "ZipCode": "sample string 8",
      "Country": "sample string 9",
      "StateProvince": "sample string 10",
      "City": "sample string 11",
      "AddressTypeId": 12
    },
    "PayBillDay": 64,
    "PaymentBankAccountInfo": {
      "BankRoutingNumber": "sample string 1",
      "BankAccountNumber": "sample string 2",
      "BankAccountType": 0
    },
    "CreditCardInfoModel": {
      "CreditCardNumber": "sample string 1",
      "ExpirationMonth": "sample string 2",
      "ExpirationYear": "sample string 3",
      "NameOnCard": "sample string 4"
    }
  },
  "PayOnPledge": {
    "Amount": 1.0,
    "BillingAddress": {
      "SecureSystemAddressId": 1,
      "AcceptAddress": true,
      "Id": 2,
      "AccountId": 3,
      "Line1": "sample string 4",
      "Line2": "sample string 5",
      "Line3": "sample string 6",
      "Line4": "sample string 7",
      "ZipCode": "sample string 8",
      "Country": "sample string 9",
      "StateProvince": "sample string 10",
      "City": "sample string 11",
      "AddressTypeId": 12
    },
    "PayToken": "sample string 2",
    "PayCurrency": "sample string 3",
    "CreditCardInfoModel": {
      "CreditCardNumber": "sample string 1",
      "ExpirationMonth": "sample string 2",
      "ExpirationYear": "sample string 3",
      "NameOnCard": "sample string 4"
    },
    "PaymentBankAccountInfo": {
      "BankRoutingNumber": "sample string 1",
      "BankAccountNumber": "sample string 2",
      "BankAccountType": 0
    }
  }
}

application/xml, text/xml

Sample:

<ChangePledgeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorSystem.Mobile.WebApi.Models">
  <ChangePledgeAmount>
    <Amount>2</Amount>
    <Id>1</Id>
  </ChangePledgeAmount>
  <ChangePledgeAutoBillingDay>
    <DayOfMonth>64</DayOfMonth>
  </ChangePledgeAutoBillingDay>
  <ChangePledgeAutoPayment>
    <BillingAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:AcceptAddress>true</d3p1:AcceptAddress>
      <d3p1:AccountId>3</d3p1:AccountId>
      <d3p1:AddressTypeId>12</d3p1:AddressTypeId>
      <d3p1:City>sample string 11</d3p1:City>
      <d3p1:Country>sample string 9</d3p1:Country>
      <d3p1:Id>2</d3p1:Id>
      <d3p1:Line1>sample string 4</d3p1:Line1>
      <d3p1:Line2>sample string 5</d3p1:Line2>
      <d3p1:Line3>sample string 6</d3p1:Line3>
      <d3p1:Line4>sample string 7</d3p1:Line4>
      <d3p1:SecureSystemAddressId>1</d3p1:SecureSystemAddressId>
      <d3p1:StateProvince>sample string 10</d3p1:StateProvince>
      <d3p1:ZipCode>sample string 8</d3p1:ZipCode>
    </BillingAddress>
    <CreditCardInfoModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:CreditCardNumber>sample string 1</d3p1:CreditCardNumber>
      <d3p1:ExpirationMonth>sample string 2</d3p1:ExpirationMonth>
      <d3p1:ExpirationYear>sample string 3</d3p1:ExpirationYear>
      <d3p1:NameOnCard>sample string 4</d3p1:NameOnCard>
    </CreditCardInfoModel>
    <PayBillDay>64</PayBillDay>
    <PaymentBankAccountInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:BankAccountNumber>sample string 2</d3p1:BankAccountNumber>
      <d3p1:BankAccountType>Checking</d3p1:BankAccountType>
      <d3p1:BankRoutingNumber>sample string 1</d3p1:BankRoutingNumber>
    </PaymentBankAccountInfo>
  </ChangePledgeAutoPayment>
  <CompanyId>1</CompanyId>
  <PayOnPledge>
    <Amount>1</Amount>
    <BillingAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:AcceptAddress>true</d3p1:AcceptAddress>
      <d3p1:AccountId>3</d3p1:AccountId>
      <d3p1:AddressTypeId>12</d3p1:AddressTypeId>
      <d3p1:City>sample string 11</d3p1:City>
      <d3p1:Country>sample string 9</d3p1:Country>
      <d3p1:Id>2</d3p1:Id>
      <d3p1:Line1>sample string 4</d3p1:Line1>
      <d3p1:Line2>sample string 5</d3p1:Line2>
      <d3p1:Line3>sample string 6</d3p1:Line3>
      <d3p1:Line4>sample string 7</d3p1:Line4>
      <d3p1:SecureSystemAddressId>1</d3p1:SecureSystemAddressId>
      <d3p1:StateProvince>sample string 10</d3p1:StateProvince>
      <d3p1:ZipCode>sample string 8</d3p1:ZipCode>
    </BillingAddress>
    <CreditCardInfoModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:CreditCardNumber>sample string 1</d3p1:CreditCardNumber>
      <d3p1:ExpirationMonth>sample string 2</d3p1:ExpirationMonth>
      <d3p1:ExpirationYear>sample string 3</d3p1:ExpirationYear>
      <d3p1:NameOnCard>sample string 4</d3p1:NameOnCard>
    </CreditCardInfoModel>
    <PayCurrency>sample string 3</PayCurrency>
    <PayToken>sample string 2</PayToken>
    <PaymentBankAccountInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
      <d3p1:BankAccountNumber>sample string 2</d3p1:BankAccountNumber>
      <d3p1:BankAccountType>Checking</d3p1:BankAccountType>
      <d3p1:BankRoutingNumber>sample string 1</d3p1:BankRoutingNumber>
    </PaymentBankAccountInfo>
  </PayOnPledge>
</ChangePledgeData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Description	Type	Additional information
HasErrors	True if there are any errors present	boolean	None.
Errors	The list of errors	Collection of ApiResultError	None.

Response Formats

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

Sample:

Sample not available.