POST api/pos/payment/ready
Makes a payment ready for the user approval using POST method.
NOTE: A payment will only be ready if it has been prepare first
Request Information
URI Parameters
None.
Body Parameters
Start payment Query parameters
QueriesPaymentReady| Name | Description | Type | Additional 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. |
Request Formats
application/xml, text/xml
<QueriesPaymentReady xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS.Models"> <accessToken xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 6</accessToken> <bioCode xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 7</bioCode> <amount>sample string 2</amount> <currencyCode>sample string 4</currencyCode> <orderId>sample string 1</orderId> <paymentId>sample string 5</paymentId> <terminalId>sample string 3</terminalId> </QueriesPaymentReady>
application/json, text/json
{
"orderId": "sample string 1",
"amount": "sample string 2",
"terminalId": "sample string 3",
"currencyCode": "sample string 4",
"paymentId": "sample string 5",
"accessToken": "sample string 6",
"bioCode": "sample string 7"
}
application/x-www-form-urlencoded
Sample not available.
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| Name | Description | Type | Additional information |
|---|---|---|---|
| message | string |
None. |
|
| success | boolean |
None. |
|
| errors | Collection of string |
None. |
Response Formats
application/xml, text/xml
<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
{
"message": "sample string 1",
"success": true,
"errors": [
"sample string 1",
"sample string 2"
]
}