POST wrapper/paymentapi/cancel

(SLPaymentAPICancel) Attempts to Cancel a Previous Transaction.

Request Information

URI Parameters

None.

Body Parameters

LSTServicesPaymentAPICancelRequest
NameDescriptionTypeAdditional information
organizationName

The User's Organization Name.

string

None.

userName

The User's Name.

string

None.

password

The User's Password.

string

None.

applicationId

The ID for the Application where the Client should be saved/accessed (Required).

string

None.

transactionId

The ID for the Transaction being processed (Required).

string

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "applicationId": "sample string 4",
  "transactionId": "sample string 5"
}

application/xml, text/xml

Sample:
<LSTServicesPaymentAPICancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <applicationId>sample string 4</applicationId>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <transactionId>sample string 5</transactionId>
  <userName>sample string 2</userName>
</LSTServicesPaymentAPICancelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesPaymentAPICancelResponse
NameDescriptionTypeAdditional information
status

The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].

SLResultTypeEnum

None.

code

A Code Value for the Status/Message returned.

SLWrapperCodes

None.

message

String containing information on the Search status/results including Error details.

string

None.

version

The version of the Wrapper.

string

None.

isiReserved

A field used to return debugging information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "code": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "isiReserved": "sample string 3"
}

application/xml, text/xml

Sample:
<LSTServicesPaymentAPICancelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <code>SUCCESS</code>
  <isiReserved>sample string 3</isiReserved>
  <message>sample string 1</message>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesPaymentAPICancelResponse>