POST v/1/Rest/Public/{client_domain}/Donations/WebPayment

Perform a payment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
client_domain

string

None.

Body Parameters

payment info

WebPaymentParameters
NameDescriptionTypeAdditional information
Form_Id

integer

None.

Amount

decimal number

None.

TaxDeductibleAmount

decimal number

None.

Contact

ContactInfoParameters

None.

CreditCardInfo

CreditCardParameters

None.

BankAccountInfo

BankAccountParameters

None.

ECheckInfo

ECheckParameters

None.

PaymentBillingInfo

PaymentBillingContactParameters

None.

RecurringFrequency

SustainerFrequencies

None.

RecurringStartDate

date

None.

RecurringEndDate

date

None.

RecurringLimit

decimal number

None.

Attribution

WebAttributionParameters

None.

MakeAnonymous

boolean

None.

DisplayNameOnlineAs

string

None.

HideAmountOnline

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Form_Id": 1,
  "Amount": 2.1,
  "TaxDeductibleAmount": 1.1,
  "Contact": {
    "PersonInfo": {
      "Prefix_Id": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "Suffix_Id": 1,
      "BirthDate": "2023-01-28T08:50:08.9639641-05:00",
      "Gender": 1
    },
    "OrganizationInfo": {
      "Name": "sample string 1",
      "Type": 8
    },
    "HouseholdInfo": {
      "Name": "sample string 1"
    },
    "AddressStreet1": "sample string 1",
    "AddressStreet2": "sample string 2",
    "AddressCity": "sample string 3",
    "AddressState": "sample string 4",
    "AddressPostalCode": "sample string 5",
    "AddressCountry": "sample string 6",
    "EmailAddress": "sample string 7",
    "PhoneNumber": "sample string 8",
    "FaxNumber": "sample string 9",
    "SmsNumber": "sample string 10",
    "MailOptIn": true,
    "EmailOptIn": true,
    "PhoneOptIn": true,
    "FaxOptIn": true,
    "SmsOptIn": true
  },
  "CreditCardInfo": {
    "CardNumber": "sample string 1",
    "ExpirationMonth": "sample string 2",
    "ExpirationYear": "sample string 3",
    "NameOnCard": "sample string 4"
  },
  "BankAccountInfo": {
    "BankAccountType": 0,
    "BankName": "sample string 1",
    "BankCity": "sample string 2",
    "BankStateProvince": "sample string 3",
    "RoutingNumber": "sample string 4",
    "AccountNumber": "sample string 5",
    "NameOnAccount": "sample string 6"
  },
  "ECheckInfo": {
    "ECheckType": 0,
    "CheckNumber": "sample string 1",
    "BankAccountInfo": {
      "BankAccountType": 0,
      "BankName": "sample string 1",
      "BankCity": "sample string 2",
      "BankStateProvince": "sample string 3",
      "RoutingNumber": "sample string 4",
      "AccountNumber": "sample string 5",
      "NameOnAccount": "sample string 6"
    }
  },
  "PaymentBillingInfo": {
    "AddressStreet1": "sample string 1",
    "AddressStreet2": "sample string 2",
    "AddressCity": "sample string 3",
    "AddressStateProvince": "sample string 4",
    "AddressPostalCode": "sample string 5",
    "AddressStateCountry": "sample string 6"
  },
  "RecurringFrequency": 1,
  "RecurringStartDate": "2023-01-28T08:50:08.9639641-05:00",
  "RecurringEndDate": "2023-01-28T08:50:08.9639641-05:00",
  "RecurringLimit": 3.1,
  "Attribution": {
    "AudienceSegment_Id": 1,
    "Initiative_Id": 2,
    "ResponseChannel_Id": 3,
    "Opportunity_Id": 4,
    "Event_Id": 5,
    "GrassrootEvent_Id": 6,
    "PeerToPeerMicrosite_Id": 7,
    "PeerToPeerTeam_Id": 8,
    "PeerToPeerPage_Id": 9,
    "Tribute_Id": 10,
    "Fund_Id": 11,
    "GeneralLedgerCode_Id": 12,
    "Solicitor": {
      "PersonInfo": {
        "Prefix_Id": 1,
        "FirstName": "sample string 1",
        "MiddleName": "sample string 2",
        "LastName": "sample string 3",
        "Suffix_Id": 1,
        "BirthDate": "2023-01-28T08:50:08.9639641-05:00",
        "Gender": 1
      },
      "OrganizationInfo": {
        "Name": "sample string 1",
        "Type": 8
      },
      "HouseholdInfo": {
        "Name": "sample string 1"
      },
      "AddressStreet1": "sample string 1",
      "AddressStreet2": "sample string 2",
      "AddressCity": "sample string 3",
      "AddressState": "sample string 4",
      "AddressPostalCode": "sample string 5",
      "AddressCountry": "sample string 6",
      "EmailAddress": "sample string 7",
      "PhoneNumber": "sample string 8",
      "FaxNumber": "sample string 9",
      "SmsNumber": "sample string 10",
      "MailOptIn": true,
      "EmailOptIn": true,
      "PhoneOptIn": true,
      "FaxOptIn": true,
      "SmsOptIn": true
    },
    "CustomCodes": {
      "Code1": "sample string 1",
      "Code2": "sample string 2",
      "Code3": "sample string 3",
      "Code4": "sample string 4",
      "Code5": "sample string 5",
      "Code6": "sample string 6",
      "Code7": "sample string 7",
      "Code8": "sample string 8"
    }
  },
  "MakeAnonymous": true,
  "DisplayNameOnlineAs": "sample string 4",
  "HideAmountOnline": true
}

application/xml, text/xml

Sample:
<WebPaymentParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>2.1</Amount>
  <Attribution>
    <AudienceSegment_Id>1</AudienceSegment_Id>
    <CustomCodes>
      <Code1>sample string 1</Code1>
      <Code2>sample string 2</Code2>
      <Code3>sample string 3</Code3>
      <Code4>sample string 4</Code4>
      <Code5>sample string 5</Code5>
      <Code6>sample string 6</Code6>
      <Code7>sample string 7</Code7>
      <Code8>sample string 8</Code8>
    </CustomCodes>
    <Event_Id>5</Event_Id>
    <Fund_Id>11</Fund_Id>
    <GeneralLedgerCode_Id>12</GeneralLedgerCode_Id>
    <GrassrootEvent_Id>6</GrassrootEvent_Id>
    <Initiative_Id>2</Initiative_Id>
    <Opportunity_Id>4</Opportunity_Id>
    <PeerToPeerMicrosite_Id>7</PeerToPeerMicrosite_Id>
    <PeerToPeerPage_Id>9</PeerToPeerPage_Id>
    <PeerToPeerTeam_Id>8</PeerToPeerTeam_Id>
    <ResponseChannel_Id>3</ResponseChannel_Id>
    <Solicitor>
      <AddressCity>sample string 3</AddressCity>
      <AddressCountry>sample string 6</AddressCountry>
      <AddressPostalCode>sample string 5</AddressPostalCode>
      <AddressState>sample string 4</AddressState>
      <AddressStreet1>sample string 1</AddressStreet1>
      <AddressStreet2>sample string 2</AddressStreet2>
      <EmailAddress>sample string 7</EmailAddress>
      <EmailOptIn>true</EmailOptIn>
      <FaxNumber>sample string 9</FaxNumber>
      <FaxOptIn>true</FaxOptIn>
      <HouseholdInfo>
        <Name>sample string 1</Name>
      </HouseholdInfo>
      <MailOptIn>true</MailOptIn>
      <OrganizationInfo>
        <Name>sample string 1</Name>
        <Type>None</Type>
      </OrganizationInfo>
      <PersonInfo>
        <BirthDate>2023-01-28T08:50:08.9639641-05:00</BirthDate>
        <FirstName>sample string 1</FirstName>
        <Gender>Male</Gender>
        <LastName>sample string 3</LastName>
        <MiddleName>sample string 2</MiddleName>
        <Prefix_Id>1</Prefix_Id>
        <Suffix_Id>1</Suffix_Id>
      </PersonInfo>
      <PhoneNumber>sample string 8</PhoneNumber>
      <PhoneOptIn>true</PhoneOptIn>
      <SmsNumber>sample string 10</SmsNumber>
      <SmsOptIn>true</SmsOptIn>
    </Solicitor>
    <Tribute_Id>10</Tribute_Id>
  </Attribution>
  <BankAccountInfo>
    <AccountNumber>sample string 5</AccountNumber>
    <BankAccountType>None</BankAccountType>
    <BankCity>sample string 2</BankCity>
    <BankName>sample string 1</BankName>
    <BankStateProvince>sample string 3</BankStateProvince>
    <NameOnAccount>sample string 6</NameOnAccount>
    <RoutingNumber>sample string 4</RoutingNumber>
  </BankAccountInfo>
  <Contact>
    <AddressCity>sample string 3</AddressCity>
    <AddressCountry>sample string 6</AddressCountry>
    <AddressPostalCode>sample string 5</AddressPostalCode>
    <AddressState>sample string 4</AddressState>
    <AddressStreet1>sample string 1</AddressStreet1>
    <AddressStreet2>sample string 2</AddressStreet2>
    <EmailAddress>sample string 7</EmailAddress>
    <EmailOptIn>true</EmailOptIn>
    <FaxNumber>sample string 9</FaxNumber>
    <FaxOptIn>true</FaxOptIn>
    <HouseholdInfo>
      <Name>sample string 1</Name>
    </HouseholdInfo>
    <MailOptIn>true</MailOptIn>
    <OrganizationInfo>
      <Name>sample string 1</Name>
      <Type>None</Type>
    </OrganizationInfo>
    <PersonInfo>
      <BirthDate>2023-01-28T08:50:08.9639641-05:00</BirthDate>
      <FirstName>sample string 1</FirstName>
      <Gender>Male</Gender>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <Prefix_Id>1</Prefix_Id>
      <Suffix_Id>1</Suffix_Id>
    </PersonInfo>
    <PhoneNumber>sample string 8</PhoneNumber>
    <PhoneOptIn>true</PhoneOptIn>
    <SmsNumber>sample string 10</SmsNumber>
    <SmsOptIn>true</SmsOptIn>
  </Contact>
  <CreditCardInfo>
    <CardNumber>sample string 1</CardNumber>
    <ExpirationMonth>sample string 2</ExpirationMonth>
    <ExpirationYear>sample string 3</ExpirationYear>
    <NameOnCard>sample string 4</NameOnCard>
  </CreditCardInfo>
  <DisplayNameOnlineAs>sample string 4</DisplayNameOnlineAs>
  <ECheckInfo>
    <BankAccountInfo>
      <AccountNumber>sample string 5</AccountNumber>
      <BankAccountType>None</BankAccountType>
      <BankCity>sample string 2</BankCity>
      <BankName>sample string 1</BankName>
      <BankStateProvince>sample string 3</BankStateProvince>
      <NameOnAccount>sample string 6</NameOnAccount>
      <RoutingNumber>sample string 4</RoutingNumber>
    </BankAccountInfo>
    <CheckNumber>sample string 1</CheckNumber>
    <ECheckType>None</ECheckType>
  </ECheckInfo>
  <Form_Id>1</Form_Id>
  <HideAmountOnline>true</HideAmountOnline>
  <MakeAnonymous>true</MakeAnonymous>
  <PaymentBillingInfo>
    <AddressCity>sample string 3</AddressCity>
    <AddressPostalCode>sample string 5</AddressPostalCode>
    <AddressStateCountry>sample string 6</AddressStateCountry>
    <AddressStateProvince>sample string 4</AddressStateProvince>
    <AddressStreet1>sample string 1</AddressStreet1>
    <AddressStreet2>sample string 2</AddressStreet2>
  </PaymentBillingInfo>
  <RecurringEndDate>2023-01-28T08:50:08.9639641-05:00</RecurringEndDate>
  <RecurringFrequency>Daily</RecurringFrequency>
  <RecurringLimit>3.1</RecurringLimit>
  <RecurringStartDate>2023-01-28T08:50:08.9639641-05:00</RecurringStartDate>
  <TaxDeductibleAmount>1.1</TaxDeductibleAmount>
</WebPaymentParameters>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WebPaymentParameters'.

Response Information

Resource Description

information of the payment result.

WebPaymentResponse
NameDescriptionTypeAdditional information
PaymentSuccessful

boolean

None.

Transaction_Id

integer

None.

Sustainer_Id

integer

None.

DeclineReason

string

None.

Successful

boolean

None.

Error

PublicApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "PaymentSuccessful": true,
  "Transaction_Id": 2,
  "Sustainer_Id": 3,
  "DeclineReason": "sample string 4",
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<WebPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>sample string 1</Message>
    <Code>None</Code>
  </Error>
  <Successful>true</Successful>
  <DeclineReason>sample string 4</DeclineReason>
  <PaymentSuccessful>true</PaymentSuccessful>
  <Sustainer_Id>3</Sustainer_Id>
  <Transaction_Id>2</Transaction_Id>
</WebPaymentResponse>