POST api/GetPaymentComponent

Returns payment component for use with TMS.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ConstituentId		integer
Amount		decimal number
CardBrandsToInclude		Collection of Object
ShowStoredCards		boolean
MerchantId		string
ComponentVersion		string

Request Formats

application/json, text/json

Sample:

{
  "ConstituentId": 1,
  "Amount": 1.0,
  "CardBrandsToInclude": null,
  "ShowStoredCards": true,
  "MerchantId": "sample string 3",
  "ComponentVersion": "sample string 4"
}

application/xml, text/xml

Sample:

<PaymentComponentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
  <Amount>1</Amount>
  <CardBrandsToInclude xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ComponentVersion>sample string 4</ComponentVersion>
  <ConstituentId>1</ConstituentId>
  <MerchantId>sample string 3</MerchantId>
  <ShowStoredCards>true</ShowStoredCards>
</PaymentComponentRequest>

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

Response Information

Resource Description

PaymentComponentResponse object

ApiSuccessOfPaymentComponentResponse

Name	Description	Type	Additional information
Success		boolean
Data		PaymentComponentResponse

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "Payload": "sample string 1",
    "Url": "sample string 2",
    "Checksum": "sample string 3",
    "ComponentVersion": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfPaymentComponentResponseuXxnEBFU 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/Tessitura.Service.Contract">
    <d2p1:Checksum>sample string 3</d2p1:Checksum>
    <d2p1:ComponentVersion>sample string 4</d2p1:ComponentVersion>
    <d2p1:Payload>sample string 1</d2p1:Payload>
    <d2p1:Url>sample string 2</d2p1:Url>
  </Data>
</ApiSuccessOfPaymentComponentResponseuXxnEBFU>