POST api/FinalizeRenewMembership

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PurchaseSessionKey	string	Required
AuthenticationSessionKey	string	Required
TransactionAmount	decimal number
CreditCardNumber	string
CreditCardName	string
CreditCardCVV	string
CreditCardExpirationMonth	integer	Range: inclusive between 1 and 12
CreditCardExpirationYear	integer
SourceId	integer
PaymentId	integer	Required
CreditCardType	integer	Required
AuthorizationCode	string	Required
PaymentReference	string	Required
AccountId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "PurchaseSessionKey": "sample string 1",
  "AuthenticationSessionKey": "sample string 2",
  "TransactionAmount": 3.0,
  "CreditCardNumber": "sample string 4",
  "CreditCardName": "sample string 5",
  "CreditCardCVV": "sample string 6",
  "CreditCardExpirationMonth": 7,
  "CreditCardExpirationYear": 8,
  "SourceId": 9,
  "PaymentId": 10,
  "CreditCardType": 11,
  "AuthorizationCode": "sample string 12",
  "PaymentReference": "sample string 13",
  "AccountId": 14
}

application/xml, text/xml

Sample:

<FinalizeContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution">
  <AccountId>14</AccountId>
  <AuthenticationSessionKey>sample string 2</AuthenticationSessionKey>
  <AuthorizationCode>sample string 12</AuthorizationCode>
  <CreditCardCVV>sample string 6</CreditCardCVV>
  <CreditCardExpirationMonth>7</CreditCardExpirationMonth>
  <CreditCardExpirationYear>8</CreditCardExpirationYear>
  <CreditCardName>sample string 5</CreditCardName>
  <CreditCardNumber>sample string 4</CreditCardNumber>
  <CreditCardType>11</CreditCardType>
  <PaymentId>10</PaymentId>
  <PaymentReference>sample string 13</PaymentReference>
  <PurchaseSessionKey>sample string 1</PurchaseSessionKey>
  <SourceId>9</SourceId>
  <TransactionAmount>3</TransactionAmount>
</FinalizeContributionRequest>

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 'FinalizeContributionRequest'.

Response Information

Resource Description

ApiSuccessOfRenewMembershipResult

Name	Description	Type	Additional information
Success		boolean
Data		RenewMembershipResult

Response Formats

application/json

Sample:

{
  "Success": true,
  "Data": {
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "MembershipPurchaseSessionKey": "ivE2l2YV0owKkW4/ZuLcumCVk1YBIRT+faBrwd97jdH7BLWvI5rx7yXghjL4nGn3ycaFj/K3TaBuosK8ZNBM9dqA2JdKVfXqw6k7P0+qCWQ=",
    "TotalAmountAddedToCart": 5.0,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 8,
    "PrimaryAddressError": true,
    "NewSessionKey": "78a5Wfb+4GCDmHYl/ld8VLjVIJZB+FtUhBUUVQQY9Qxio/ECtrzpzbH5KN2/H5UeR0m85PNd6dqLuJbBufeH9RxY/Y3bTTxt7gErLJdkJHNzNAgcu1vPBZtC00iDHlQi",
    "Error": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 11",
    "Message": "sample string 12"
  }
}

text/json

Sample:

{
  "Success": true,
  "Data": {
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "MembershipPurchaseSessionKey": "zUIGGuf4pZs14c9emexUr3LBiEsgnqe3TIaa48atZ6FqgrOxpTK1vxa97wSgkA/J69Z0C1z0aam9OdYaEPkehd3VaZZLBWZ25kAglJ7d3EA=",
    "TotalAmountAddedToCart": 5.0,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 8,
    "PrimaryAddressError": true,
    "NewSessionKey": "mTmUwUBP4ku2UlvGWyyB+LP65htU3fpK1DnJcQUx7kuAFeEwfu4vvtMR+LhwJU7HEqVyuMQsqAV3cOUf1yK1Fb60WupjafZVG93wbNRQfoc0+jUZO6y2te/aRqLxgl0V",
    "Error": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 11",
    "Message": "sample string 12"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfRenewMembershipResultyx5QZ_PAX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution">
    <Error xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Error>
    <Message xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 12</Message>
    <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 10</NewSessionKey>
    <OrderEmailSent xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</OrderEmailSent>
    <OrderNumber xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">8</OrderNumber>
    <PrimaryAddressError xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PrimaryAddressError>
    <PurchaseCompleted xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PurchaseCompleted>
    <Status xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 11</Status>
    <d2p1:AddOnMembershipsAdded>
      <d2p1:AddOnMembership>
        <d2p1:MembershipAmount>2</d2p1:MembershipAmount>
        <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel>
      </d2p1:AddOnMembership>
      <d2p1:AddOnMembership>
        <d2p1:MembershipAmount>2</d2p1:MembershipAmount>
        <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel>
      </d2p1:AddOnMembership>
    </d2p1:AddOnMembershipsAdded>
    <d2p1:AdditionalDonationAdded>true</d2p1:AdditionalDonationAdded>
    <d2p1:AutoRenewalPaymentSaved>true</d2p1:AutoRenewalPaymentSaved>
    <d2p1:MembershipDonationAdded>true</d2p1:MembershipDonationAdded>
    <d2p1:MembershipPurchaseSessionKey>sample string 4</d2p1:MembershipPurchaseSessionKey>
    <d2p1:TotalAmountAddedToCart>5</d2p1:TotalAmountAddedToCart>
  </Data>
</ApiSuccessOfRenewMembershipResultyx5QZ_PAX>