POST api/FinalizePayment

Returns finalize payment for use with TMS.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PaymentId		integer
StoreAccount		boolean
ActionData		string
RedirectResult		string

Request Formats

application/json, text/json

Sample:

{
  "PaymentId": 1,
  "StoreAccount": true,
  "ActionData": "sample string 2",
  "RedirectResult": "sample string 3"
}

application/xml, text/xml

Sample:

<FinalizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
  <ActionData>sample string 2</ActionData>
  <PaymentId>1</PaymentId>
  <RedirectResult>sample string 3</RedirectResult>
  <StoreAccount>true</StoreAccount>
</FinalizeRequest>

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

Response Information

Resource Description

AuthorizationResponse object

ApiSuccessOfAuthorizationResponse

Name	Description	Type	Additional information
Success		boolean
Data		AuthorizationResponse

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ResponseCode": "sample string 1",
    "ResponseMessage": "sample string 2",
    "AuthorizationCode": "sample string 3",
    "ReferenceNumber": "sample string 4",
    "AccountId": 5,
    "CVVResponseCode": "sample string 6",
    "AVSResponseCode": "sample string 7",
    "Succeeded": true,
    "IsPartialAuth": true,
    "AuthorizedAmount": 10.0,
    "BalanceAmount": 11.0,
    "BalanceCurrencyCode": "sample string 12",
    "PaymentMethod": {
      "AccountType": {
        "Id": 1,
        "Description": "sample string 1",
        "CardPrefix": "sample string 2",
        "CardtypeIndicator": "sample string 3",
        "EditMask": "sample string 4",
        "Inactive": true
      },
      "AuthIndicator": true,
      "BusinessUnitId": 2,
      "RequireCheckIndicator": true,
      "CreatedDateTime": "2024-12-04T20:32:34.1313205+00:00",
      "CreateLocation": "sample string 4",
      "CreatedBy": "sample string 5",
      "CurrencyTypeId": 1,
      "DefaultIndicator": true,
      "Description": "sample string 7",
      "GiftAidIndicator": true,
      "Id": 1,
      "Inactive": true,
      "Income": true,
      "CanRefund": true,
      "UpdatedDateTime": "2024-12-04T20:32:34.1313205+00:00",
      "UpdatedBy": "sample string 12",
      "NoCopiesOnAuth": 1,
      "NoCopiesOnSave": 1,
      "PaymentMethodGroup": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "MerchantId": "sample string 3"
      },
      "PaymentType": {
        "Id": 1,
        "Description": "sample string 1"
      },
      "ReceiptFormatId": 1,
      "RequirePostalCode": "sample string 13",
      "ShortDesc": "sample string 14",
      "StoreTenderedAmount": true,
      "OpenCashDrawer": true,
      "RequireCvv": true,
      "UseWithCardReader": true,
      "GlAccountId": "sample string 19",
      "MerchantId": "sample string 20",
      "MerchantIdForSwipe": "sample string 21",
      "ControlGroup": {
        "<Description>k__BackingField": "sample string 1",
        "<Id>k__BackingField": 2,
        "<Inactive>k__BackingField": true
      }
    },
    "TessituraMerchantServicesAction": "sample string 13",
    "ShopperIp": "sample string 14",
    "MaskedCardNumber": "sample string 15"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfAuthorizationResponseuXxnEBFU 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:AVSResponseCode>sample string 7</d2p1:AVSResponseCode>
    <d2p1:AccountId>5</d2p1:AccountId>
    <d2p1:AuthorizationCode>sample string 3</d2p1:AuthorizationCode>
    <d2p1:AuthorizedAmount>10</d2p1:AuthorizedAmount>
    <d2p1:BalanceAmount>11</d2p1:BalanceAmount>
    <d2p1:BalanceCurrencyCode>sample string 12</d2p1:BalanceCurrencyCode>
    <d2p1:CVVResponseCode>sample string 6</d2p1:CVVResponseCode>
    <d2p1:IsPartialAuth>true</d2p1:IsPartialAuth>
    <d2p1:MaskedCardNumber>sample string 15</d2p1:MaskedCardNumber>
    <d2p1:PaymentMethod>
      <d2p1:AccountType>
        <d2p1:CardPrefix>sample string 2</d2p1:CardPrefix>
        <d2p1:CardtypeIndicator>sample string 3</d2p1:CardtypeIndicator>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:EditMask>sample string 4</d2p1:EditMask>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
      </d2p1:AccountType>
      <d2p1:AuthIndicator>true</d2p1:AuthIndicator>
      <d2p1:BusinessUnitId>2</d2p1:BusinessUnitId>
      <d2p1:CanRefund>true</d2p1:CanRefund>
      <d2p1:ControlGroup>
        <d2p1:_x003C_Description_x003E_k__BackingField>sample string 1</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>2</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_Inactive_x003E_k__BackingField>true</d2p1:_x003C_Inactive_x003E_k__BackingField>
      </d2p1:ControlGroup>
      <d2p1:CreateLocation>sample string 4</d2p1:CreateLocation>
      <d2p1:CreatedBy>sample string 5</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2024-12-04T20:32:34.1313205+00:00</d2p1:CreatedDateTime>
      <d2p1:CurrencyTypeId>1</d2p1:CurrencyTypeId>
      <d2p1:DefaultIndicator>true</d2p1:DefaultIndicator>
      <d2p1:Description>sample string 7</d2p1:Description>
      <d2p1:GiftAidIndicator>true</d2p1:GiftAidIndicator>
      <d2p1:GlAccountId>sample string 19</d2p1:GlAccountId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:Income>true</d2p1:Income>
      <d2p1:MerchantId>sample string 20</d2p1:MerchantId>
      <d2p1:MerchantIdForSwipe>sample string 21</d2p1:MerchantIdForSwipe>
      <d2p1:NoCopiesOnAuth>1</d2p1:NoCopiesOnAuth>
      <d2p1:NoCopiesOnSave>1</d2p1:NoCopiesOnSave>
      <d2p1:OpenCashDrawer>true</d2p1:OpenCashDrawer>
      <d2p1:PaymentMethodGroup>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:MerchantId>sample string 3</d2p1:MerchantId>
      </d2p1:PaymentMethodGroup>
      <d2p1:PaymentType>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:PaymentType>
      <d2p1:ReceiptFormatId>1</d2p1:ReceiptFormatId>
      <d2p1:RequireCheckIndicator>true</d2p1:RequireCheckIndicator>
      <d2p1:RequireCvv>true</d2p1:RequireCvv>
      <d2p1:RequirePostalCode>sample string 13</d2p1:RequirePostalCode>
      <d2p1:ShortDesc>sample string 14</d2p1:ShortDesc>
      <d2p1:StoreTenderedAmount>true</d2p1:StoreTenderedAmount>
      <d2p1:UpdatedBy>sample string 12</d2p1:UpdatedBy>
      <d2p1:UpdatedDateTime>2024-12-04T20:32:34.1313205+00:00</d2p1:UpdatedDateTime>
      <d2p1:UseWithCardReader>true</d2p1:UseWithCardReader>
    </d2p1:PaymentMethod>
    <d2p1:ReferenceNumber>sample string 4</d2p1:ReferenceNumber>
    <d2p1:ResponseCode>sample string 1</d2p1:ResponseCode>
    <d2p1:ResponseMessage>sample string 2</d2p1:ResponseMessage>
    <d2p1:ShopperIp>sample string 14</d2p1:ShopperIp>
    <d2p1:Succeeded>true</d2p1:Succeeded>
    <d2p1:TessituraMerchantServicesAction>sample string 13</d2p1:TessituraMerchantServicesAction>
  </Data>
</ApiSuccessOfAuthorizationResponseuXxnEBFU>