POST wrapper/payment

(SLPayment) Processes a Generic Payment, screening the different Names/Banks/Currency within the Payment .

Request Information

URI Parameters

None.

Body Parameters

Wrapper Request LSTServicesPaymentRequest

LSTServicesPaymentRequest
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 Transaction being processed.

string

None.

transactionId

The ID for the Transaction being processed.

string

None.

sender

The Details for the Person sending the Payment.

SLPaymentPerson

None.

senderBank

The Details for the Bank that will be sending the Sender's Payment.

SLPaymentBank

None.

beneficiary

The Details for the Person receiving the Payment.

SLPaymentPerson

None.

beneficiaryBank

The Details for the Bank that will be receiving the Beneficiary's Payment.

SLPaymentBank

None.

intermediary

The Details for the Banks the Payment will be transferred through.

Collection of SLPaymentBank

None.

transactionReference

The reference assigned by the Sender to unambiguously .

string

None.

transactionCoveringReference

The unique reference for the individual transaction.

string

None.

notesInstructions

The Institution Notes/Payment Instructions of the individual transaction or a reference to another message containing the details which are to be transmitted between sender and beneficiary customers.

string

None.

sendertoBeneficiaryNotes

The notes from the Sender to the Beneficiary.

string

None.

dateTime

The Date and Time of the Payment.

date

None.

currency

The type of currency being transferred.

string

None.

amount

The amount of currency being transferred.

decimal number

None.

direction

The direction the currency is being transferred [In or Out]

SLDirectionEnum

None.

messageType

The type of Payment message being sent.

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",
  "sender": {
    "name": "sample string 1",
    "address": "sample string 2",
    "country": "sample string 3",
    "account": "sample string 4"
  },
  "senderBank": {
    "name": "sample string 1",
    "address": "sample string 2",
    "country": "sample string 3",
    "code": "sample string 4"
  },
  "beneficiary": {
    "name": "sample string 1",
    "address": "sample string 2",
    "country": "sample string 3",
    "account": "sample string 4"
  },
  "beneficiaryBank": {
    "name": "sample string 1",
    "address": "sample string 2",
    "country": "sample string 3",
    "code": "sample string 4"
  },
  "intermediary": [
    {
      "name": "sample string 1",
      "address": "sample string 2",
      "country": "sample string 3",
      "code": "sample string 4"
    },
    {
      "name": "sample string 1",
      "address": "sample string 2",
      "country": "sample string 3",
      "code": "sample string 4"
    }
  ],
  "transactionReference": "sample string 6",
  "transactionCoveringReference": "sample string 7",
  "notesInstructions": "sample string 8",
  "sendertoBeneficiaryNotes": "sample string 9",
  "dateTime": "2019-12-18T09:26:31.2332517+00:00",
  "currency": "sample string 11",
  "amount": 12.0,
  "direction": 0,
  "messageType": "sample string 13"
}

application/xml, text/xml

Sample:
<LSTServicesPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <amount>12</amount>
  <applicationId>sample string 4</applicationId>
  <beneficiary>
    <account>sample string 4</account>
    <address>sample string 2</address>
    <country>sample string 3</country>
    <name>sample string 1</name>
  </beneficiary>
  <beneficiaryBank>
    <address>sample string 2</address>
    <code>sample string 4</code>
    <country>sample string 3</country>
    <name>sample string 1</name>
  </beneficiaryBank>
  <currency>sample string 11</currency>
  <dateTime>2019-12-18T09:26:31.2332517+00:00</dateTime>
  <direction>In</direction>
  <intermediary>
    <SLPaymentBank>
      <address>sample string 2</address>
      <code>sample string 4</code>
      <country>sample string 3</country>
      <name>sample string 1</name>
    </SLPaymentBank>
    <SLPaymentBank>
      <address>sample string 2</address>
      <code>sample string 4</code>
      <country>sample string 3</country>
      <name>sample string 1</name>
    </SLPaymentBank>
  </intermediary>
  <messageType>sample string 13</messageType>
  <notesInstructions>sample string 8</notesInstructions>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <sender>
    <account>sample string 4</account>
    <address>sample string 2</address>
    <country>sample string 3</country>
    <name>sample string 1</name>
  </sender>
  <senderBank>
    <address>sample string 2</address>
    <code>sample string 4</code>
    <country>sample string 3</country>
    <name>sample string 1</name>
  </senderBank>
  <sendertoBeneficiaryNotes>sample string 9</sendertoBeneficiaryNotes>
  <transactionCoveringReference>sample string 7</transactionCoveringReference>
  <transactionId>sample string 5</transactionId>
  <transactionReference>sample string 6</transactionReference>
  <userName>sample string 2</userName>
</LSTServicesPaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Match information

LSTServicesPaymentResponse
NameDescriptionTypeAdditional information
status

The Current Status of the call [Pass, Pending or Fail]. If potential matches are found, the Status returned will be Pending until all of the potential matches have been reviewed, even if one or more matches are set as a Hit.

SLResultTypeEnum

None.

message

Information on the call results including Error details.

string

None.

resultCode

The Result Code returned by the call to FinScan.

string

None.

result

The Result String returned by the call to FinScan.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "message": "sample string 1",
  "resultCode": "sample string 2",
  "result": "sample string 3"
}

application/xml, text/xml

Sample:
<LSTServicesPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <message>sample string 1</message>
  <result>sample string 3</result>
  <resultCode>sample string 2</resultCode>
  <status>PASS</status>
</LSTServicesPaymentResponse>