GET api/pos/payment/id/retrieve/bystate?orderId={orderId}&state={state}&accessToken={accessToken}&bioCode={bioCode}

In case the paymentId has been lost it can be retrieved by calling this API.
This works only if the payment status that you supply is Captured

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

Required: orderId

string

None.

state

Required : state of the payment i.e Captured

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 query the details or the action you want to do.

PosPaymentRetrieveViewModel
NameDescriptionTypeAdditional information
paymentId

string

None.

success

boolean

None.

errors

Collection of string

None.

Response Formats

application/xml, text/xml

Sample:
<PosPaymentRetrieveViewModel 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>
</PosPaymentRetrieveViewModel>

application/json, text/json

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