GET api/pos/payment/status?paymentId={paymentId}&accessToken={accessToken}&bioCode={bioCode}
Gets a payment status.
NOTE:The possible status values are:
- Initiated
- Prepared
- Paired
- IssuedToUser
- Reserved
This means, the user has approved the payment ready to capture
- Captured
- CancelledByUser
- CancelledByClient
- CancelledByMobilePay
- ExpiredAndCancelled
- RejectedByMobilePayDueToAgeRestrictions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| paymentId |
Required: paymentId |
string |
None. |
| accessToken | string |
None. |
|
| bioCode | string |
None. |
Body Parameters
None.
Response Information
Resource Description
status if success is true, otherwise errors.
PosPaymentStatusViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| status | string |
None. |
|
| success | boolean |
None. |
|
| errors | Collection of string |
None. |
Response Formats
application/xml, text/xml
Sample:
<PosPaymentStatusViewModel 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>
<status>sample string 1</status>
</PosPaymentStatusViewModel>
application/json, text/json
Sample:
{
"status": "sample string 1",
"success": true,
"errors": [
"sample string 1",
"sample string 2"
]
}