PUT api/Pledge
Create a new pledge
Request Information
URI Parameters
None.
Body Parameters
The pledge to create
Collection of PledgeName | Description | Type | Additional information |
---|---|---|---|
SecureSystemPledgeId | integer |
None. |
|
CreditCardNumber | string |
None. |
|
CreditCardExpirationMonth | string |
None. |
|
CreditCardExpirationYear | string |
None. |
|
CreditCardNameOnCard | string |
None. |
|
BankAccount | string |
None. |
|
BankRouting | string |
None. |
|
BankType | BankAccountTypes |
None. |
|
BillingAddress | Address |
None. |
|
IsPrayerPledge | boolean |
None. |
|
IsContest | boolean |
None. |
|
SystemModStamp | date |
None. |
|
CardBrand | string |
None. |
|
TrackingDescriptors | Collection of Pair of string [key] and string [value] |
None. |
|
DescriptorCode | string |
None. |
|
DonationId | integer |
None. |
|
PersonalScriptingResponse | QuestionResponse |
None. |
|
Id | integer |
None. |
|
AccountId | integer |
None. |
|
CompanyId | integer |
None. |
|
PledgeCode | string |
None. |
|
SourceCode | string |
None. |
|
StartDate | date |
None. |
|
Frequency | string |
None. |
|
Amount | decimal number |
None. |
|
IsAutoPay | boolean |
None. |
|
SystemAutoPayId | integer |
None. |
|
PayAmount | decimal number |
None. |
|
PayCurrency | string |
None. |
|
PayBillDay | byte |
None. |
|
PayPaymentType | string |
None. |
|
PayReferenceNumber | string |
None. |
|
PayToken | string |
None. |
|
PayAddressId | integer |
None. |
|
CancelReason | string |
None. |
|
Comment | string |
None. |
|
Instructions | string |
None. |
|
TrackingCode | string |
None. |
|
PayProjectCode | string |
None. |
|
PledgeStatus | string |
None. |
|
CreatedBy | string |
None. |
|
PrayerNote | string |
None. |
|
PrayerNoteType | string |
None. |
|
IsAnonymous | boolean |
None. |
|
PledgeSessionId | string |
None. |
|
ExtSystemId | globally unique identifier |
None. |
|
Transport | string |
None. |
|
IsGeneralFund | boolean |
None. |
|
Account | Account |
None. |
|
Company | Company |
None. |
|
OnlineDonationDetails | Collection of OnlineDonationDetail |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResultName | 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.