GET api/pos/payment/details?paymentId={paymentId}&accessToken={accessToken}&bioCode={bioCode}
Query the payment details.
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
paymentDetails if success is true, otherwise errors
PosPaymentDetailsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| paymentDetails | QueryPaymentResponse |
None. |
|
| success | boolean |
None. |
|
| errors | Collection of string |
None. |
Response Formats
application/xml, text/xml
Sample:
<PosPaymentDetailsViewModel 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>
<paymentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_Models.MobilePay">
<d2p1:amount>4</d2p1:amount>
<d2p1:currencyCode>sample string 5</d2p1:currencyCode>
<d2p1:customerReceiptToken>sample string 10</d2p1:customerReceiptToken>
<d2p1:customerToken>sample string 9</d2p1:customerToken>
<d2p1:loyaltyIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</d2p1:loyaltyIds>
<d2p1:merchantPaymentLabel>sample string 7</d2p1:merchantPaymentLabel>
<d2p1:orderId>sample string 3</d2p1:orderId>
<d2p1:partialCapturePossible>true</d2p1:partialCapturePossible>
<d2p1:paymentExpiresAt>sample string 11</d2p1:paymentExpiresAt>
<d2p1:paymentId>sample string 2</d2p1:paymentId>
<d2p1:plannedCaptureDelay>sample string 8</d2p1:plannedCaptureDelay>
<d2p1:pollDelayInMs>13</d2p1:pollDelayInMs>
<d2p1:posId>sample string 1</d2p1:posId>
<d2p1:restrictions>
<d2p1:creditCardDisallowed>true</d2p1:creditCardDisallowed>
<d2p1:debitCardDisallowed>true</d2p1:debitCardDisallowed>
</d2p1:restrictions>
<d2p1:status>sample string 6</d2p1:status>
</paymentDetails>
</PosPaymentDetailsViewModel>
application/json, text/json
Sample:
{
"paymentDetails": {
"posId": "sample string 1",
"paymentId": "sample string 2",
"orderId": "sample string 3",
"amount": 4.0,
"currencyCode": "sample string 5",
"status": "sample string 6",
"restrictions": {
"creditCardDisallowed": true,
"debitCardDisallowed": true
},
"merchantPaymentLabel": "sample string 7",
"plannedCaptureDelay": "sample string 8",
"customerToken": "sample string 9",
"customerReceiptToken": "sample string 10",
"loyaltyIds": [
"sample string 1",
"sample string 2"
],
"paymentExpiresAt": "sample string 11",
"partialCapturePossible": true,
"pollDelayInMs": 13
},
"success": true,
"errors": [
"sample string 1",
"sample string 2"
]
}