POST api/FinalizeNewMembership

Processes and bills a gift membership.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PurchaseSessionKey		string	Required
AuthenticationSessionKey		string	Required
TransactionAmount		decimal number
CreditCardNumber		string
CreditCardName	Name on credit card	string
CreditCardCVV		string
CreditCardExpirationMonth		integer	Range: inclusive between 1 and 12
CreditCardExpirationYear		integer
SourceId	For optional source id that will be used for the membership purchase session	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

GiftMembershipResult object

ApiSuccessOfNewMembershipResult

Name	Description	Type	Additional information
Success		boolean
Data		NewMembershipResult

Response Formats

application/json

Sample:

{
  "Success": true,
  "Data": {
    "SessionKey": "fp2E6jsrGqmsNlnVvyYl10MQvg+yNX94OLV3cS/CpYlidbIjqwRGo9TH04bIIZlQ9UV6lNj7hPIg+LQDiwpPZ4ldrCurZjnkTUwyUlzz9lE=",
    "AccountRegistered": true,
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "MembershipPurchaseSessionKey": "AAQac9/kqU9lf7ihDdBPyGYX3lJhcM5IfJVIT9P8WUz6VNWE+3Qvh5aMHh5cSbjfD3w0NuI7lW5fj9ciTSvP+RA391nNczzqwa7CrPhf5ZE=",
    "TotalAmountAddedToCart": 7.0,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 10,
    "PrimaryAddressError": true,
    "NewSessionKey": "aX4jHULBIbuDLuLH3oxA9vtT0O1b/6nufFjgFHpCUmxYtAtdLtffqNomFMBIFQij8In3DPwHCwwbXOVMC5gLXTHgHZWwAlSwxq3R+IxoNwR0rGILal90S0UJzYG49XkO",
    "Error": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 13",
    "Message": "sample string 14"
  }
}

text/json

Sample:

{
  "Success": true,
  "Data": {
    "SessionKey": "455ze+BfoXv8VicIsnHic1HAWlm0/cR5V1fyqVvmFzu/XFttTm9KjeaIG1dsqrzMwZK+xa26PTONrut4UIo+wTg/CieZZcFSwoyPSrcd32s=",
    "AccountRegistered": true,
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "MembershipPurchaseSessionKey": "qolZX+bb+EbVCE/PbzD+OspEb5PbaMOXJJ1tuWWZpNjQhYM9mA3hw+f1gjKCt4ThjVwv3lqsFmIU786YwKlQEr2/Ph4Gu2ICwIluyYiHuuk=",
    "TotalAmountAddedToCart": 7.0,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 10,
    "PrimaryAddressError": true,
    "NewSessionKey": "NXAK4ELwcM2ZbS6z18cazPB5mHKhzIkxxczo5qK+FGrZ5H1I3YFFuEavRIlYHSAReKBddxvWvsWz6d71mwbugCbTVODGiFPYAlfQCtacZce+CVs1SC6PVjiS81W0vH0H",
    "Error": [
      "sample string 1",
      "sample string 2"
    ],
    "Status": "sample string 13",
    "Message": "sample string 14"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfNewMembershipResultyx5QZ_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 14</Message>
    <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 12</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">10</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 13</Status>
    <d2p1:AccountRegistered>true</d2p1:AccountRegistered>
    <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 6</d2p1:MembershipPurchaseSessionKey>
    <d2p1:SessionKey>sample string 1</d2p1:SessionKey>
    <d2p1:TotalAmountAddedToCart>7</d2p1:TotalAmountAddedToCart>
  </Data>
</ApiSuccessOfNewMembershipResultyx5QZ_PAX>