GET api/pos/payment/cancel?paymentId={paymentId}&accessToken={accessToken}&bioCode={bioCode}

Cancel a payment.
NOTE : You can cancel a payment at any state but not when you have already Capture a payment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
paymentId

Required: paymentId

string

None.

accessToken

string

None.

bioCode

string

None.

Body Parameters

None.

Response Information

Resource Description

message if success is true, otherwise errors

PosPaymentViewModel
NameDescriptionTypeAdditional information
message

string

None.

success

boolean

None.

errors

Collection of string

None.

Response Formats

application/xml, text/xml

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

application/json, text/json

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