GET api/pos/payment/ready?orderId={orderId}&amount={amount}&terminalId={terminalId}&currencyCode={currencyCode}&paymentId={paymentId}&accessToken={accessToken}&bioCode={bioCode}

Makes a payment ready for the user approval.
NOTE: A payment will only be ready if it has been prepare first

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

Required: The orderId

string

None.

amount

Required: The amount. format double ex. 27.00

string

None.

terminalId

Required: The terminalId

string

None.

currencyCode

Default is DKK

string

None.

paymentId

Required: The paymentId received after preparing a payment

string

None.

accessToken

string

None.

bioCode

string

None.

Body Parameters

None.

Response Information

Resource Description

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

PosPaymentReadyViewModel
NameDescriptionTypeAdditional information
message

string

None.

success

boolean

None.

errors

Collection of string

None.

Response Formats

application/xml, text/xml

Sample:
<PosPaymentReadyViewModel 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>
  <message>sample string 1</message>
</PosPaymentReadyViewModel>

application/json, text/json

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