POST api/pos/payment/start

Starts a payment by initiating a new payment based on the terminalId using POST method.
Upon calling this API, It will read the merchant information and terminal information from Integra.
NOTE: A payment will only be initiated if there is no any active payment on the Pos

Request Information

URI Parameters

None.

Body Parameters

Start payment query parameters

PosStartPaymentViewModel

Name	Type	Additional information
orderId	string	None.
amount	string	None.
terminalId	string	None.
currencyCode	string	None.
accessToken	string	None.
bioCode	string	None.

Request Formats

application/xml, text/xml

Sample:

<PosStartPaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">
  <accessToken xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 5</accessToken>
  <bioCode xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 6</bioCode>
  <amount>sample string 2</amount>
  <currencyCode>sample string 4</currencyCode>
  <orderId>sample string 1</orderId>
  <terminalId>sample string 3</terminalId>
</PosStartPaymentViewModel>

application/json, text/json

Sample:

{
  "orderId": "sample string 1",
  "amount": "sample string 2",
  "terminalId": "sample string 3",
  "currencyCode": "sample string 4",
  "accessToken": "sample string 5",
  "bioCode": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

paymentId if success is true, otherwise errors. You can use the paymentId to query payment status and capture the payment when its status is Reserved

PaymentStartViewModel

Name	Type	Additional information
paymentId	string	None.
success	boolean	None.
errors	Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<PaymentStartViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <success>true</success>
  <paymentId>sample string 1</paymentId>
</PaymentStartViewModel>

application/json, text/json

Sample:

{
  "paymentId": "sample string 1",
  "success": true,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}