PaymentComponent Test
PaymentGateway/PaymentComponent
This request is used to configure a transaction and retrieve the JavaScript location for implementing the Tessitura Merchant Services Payment Component.

For complete documentation on how to implement the Payment Component, please visit https://bitbucket.org/TN_WebShare/tessituramerchantservicesintegrationsample
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/PaymentComponent

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : PaymentComponentRequest

Request object type PaymentComponentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Specifies the amount to charge of the current order, which determines available payment methods and display of the currency in the form.
CardBrandsToInclude Collection of string N If specified, filters the card brands which can be used for this payment, passed as an array of strings i.e. [ “amex”, “mc”, “visa” ]. If not specified, all card brands configured on the Merchant Account are returned. For a complete list of card brand values, visit the full documentation located here: https://bitbucket.org/TN_WebShare/tessituramerchantservicesintegrationsample.
ComponentVersion string N If specified, overrides the Payment_Component_Version default from T_DEFAULTS.
ConstituentId integer N If specified, used to retrieve the Constituent’s stored payment methods such as previously saved credit cards, if applicable. If both this filter and the optional card brand filter are passed, only the union of the two datasets will be returned. For example. If you pass "mc" for the brand filter, and a CustomerId which has a visa token and a Mastercard token saved to their account, only the Mastercard token will be returned for use. ConstituentId is not validated as part of this request. If an invalid customerNo is passed, the request will succeed and return no acount tokens, since the account is invalid.
MerchantId string N Specifies the merchant id to use for transactions. If not specified, the merchant id from the payment method of the generic credit card will be used.
ShowStoredCards boolean N Display stored cards in the component. If not specified, stored cards are shown. 
{
  "ConstituentId": 1,
  "Amount": 1.0,
  "CardBrandsToInclude": [
    "sample string 1",
    "sample string 2"
  ],
  "ShowStoredCards": true,
  "MerchantId": "sample string 3",
  "ComponentVersion": "sample string 4"
}
<PaymentComponentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <CardBrandsToInclude>
    <CardBrand>sample string 1</CardBrand>
    <CardBrand>sample string 2</CardBrand>
  </CardBrandsToInclude>
  <ComponentVersion>sample string 4</ComponentVersion>
  <ConstituentId>1</ConstituentId>
  <MerchantId>sample string 3</MerchantId>
  <ShowStoredCards>true</ShowStoredCards>
</PaymentComponentRequest>

Response object type : PaymentComponentResponse

Response object type PaymentComponentResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
Checksum string Checksum of the latest version of the Payment Component JavaScript library. Used to set the integrity attribute of the script element for Subresource Integrity (SRI) validation.
ComponentVersion string The Payment Component version that has been provided.
Payload string An encoded payload to be passed to the Payment Component for initialization.
Url string Url to the latest version of the Payment Component JavaScript library. Used to construct an HTML script element to load the Payment Component JavaScript library. 
{
  "Payload": "sample string 1",
  "Url": "sample string 2",
  "Checksum": "sample string 3",
  "ComponentVersion": "sample string 4"
}
<PaymentComponentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Checksum>sample string 3</Checksum>
  <ComponentVersion>sample string 4</ComponentVersion>
  <Payload>sample string 1</Payload>
  <Url>sample string 2</Url>
</PaymentComponentResponse>
Change Version Description Contract Old New
Property Added 15.2.40 ComponentVersion has been added to PaymentComponentResponse PaymentComponentResponse PaymentComponentResponse.ComponentVersion
Property Added 15.2.40 ComponentVersion has been added to PaymentComponentRequest PaymentComponentRequest PaymentComponentRequest.ComponentVersion
Property Added 15.2.38 MerchantId has been added to PaymentComponentRequest PaymentComponentRequest PaymentComponentRequest.MerchantId
Property Added 15.2.38 ShowStoredCards has been added to PaymentComponentRequest PaymentComponentRequest PaymentComponentRequest.ShowStoredCards
Property Added 15.2.30 CardBrandsToInclude has been added to PaymentComponentRequest PaymentComponentRequest PaymentComponentRequest.CardBrandsToInclude
Resource Added 15.2.28 New resource added. PaymentComponent