GET api/pos/payment/prepare?orderId={orderId}&terminalId={terminalId}&accessToken={accessToken}&bioCode={bioCode}
The prepared payment flow makes the payment accessible to the customer on creation, pending an amount.
Only when the payment is readied will the customer be able to make the approval.
As an example, this flow could be used to start a payment before the payment amount is known.This could for instance be because goods are still being scanned at a cash register or to support loyalty flows.
When using this payment flow, you will always need to call the api pos/payment/ready after preparing a payment.
A payment will only be prepare if there is no any active payment on the Pos
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderId |
Required: The orderId |
string |
None. |
| terminalId |
Required: The terminalId |
string |
None. |
| accessToken | string |
None. |
|
| bioCode | string |
None. |
Body Parameters
None.
Response Information
Resource Description
paymentId if success is true, otherwise errors . You can use the paymentId to call payment ready (api/pos/payment/ready)
PaymentStartViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| paymentId | string |
None. |
|
| success | boolean |
None. |
|
| errors | Collection of string |
None. |
Response Formats
application/xml, text/xml
<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
{
"paymentId": "sample string 1",
"success": true,
"errors": [
"sample string 1",
"sample string 2"
]
}