GET api/vipps/epayment/cancel?terminalId={terminalId}&paymentId={paymentId}&amount={amount}&currencyCode={currencyCode}&accessToken={accessToken}&bioCode={bioCode}

Cancel a payment.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

paymentCancelResponse if success is true, otherwise errors

VippsEPaymentCancelViewModel

Name	Description	Type	Additional information
paymentCancelResponse	Payment cancel details	GetEPaymentCancelResponse	None.
success		boolean	None.
errors		Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<VippsEPaymentCancelViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS.Models">
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <success xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">true</success>
  <paymentCancelResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/_1SA.VippsMobilePay.Library">
    <d2p1:Aggregated>
      <d2p1:AggregatedPayment>
        <d2p1:Amount>1</d2p1:Amount>
        <d2p1:Currency>sample string 2</d2p1:Currency>
        <d2p1:State>sample string 3</d2p1:State>
      </d2p1:AggregatedPayment>
      <d2p1:AggregatedPayment>
        <d2p1:Amount>1</d2p1:Amount>
        <d2p1:Currency>sample string 2</d2p1:Currency>
        <d2p1:State>sample string 3</d2p1:State>
      </d2p1:AggregatedPayment>
    </d2p1:Aggregated>
    <d2p1:Amount>2</d2p1:Amount>
    <d2p1:Currency>sample string 3</d2p1:Currency>
    <d2p1:PspReference>sample string 4</d2p1:PspReference>
    <d2p1:Reference>sample string 1</d2p1:Reference>
    <d2p1:State>sample string 5</d2p1:State>
  </paymentCancelResponse>
</VippsEPaymentCancelViewModel>

application/json, text/json

Sample:

{
  "paymentCancelResponse": {
    "Reference": "sample string 1",
    "Amount": 2.0,
    "Currency": "sample string 3",
    "PspReference": "sample string 4",
    "State": "sample string 5",
    "Aggregated": [
      {
        "Amount": 1.0,
        "Currency": "sample string 2",
        "State": "sample string 3"
      },
      {
        "Amount": 1.0,
        "Currency": "sample string 2",
        "State": "sample string 3"
      }
    ]
  },
  "success": true,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}