GET api/pos/refund/create?amount={amount}&currencyCode={currencyCode}&paymentId={paymentId}&refundOrderId={refundOrderId}&accessToken={accessToken}&bioCode={bioCode}

Create a refund

Request Information

URI Parameters

NameDescriptionTypeAdditional information
amount

Required: amount to refund in double formation ex. 27.06

string

None.

currencyCode

currency code, default DKK

string

None.

paymentId

Required: paymentId. In case it has been lost use api/payment/id/retrieve to retrieve the paymentId (see the documentation)

string

None.

refundOrderId

Required: the orderId to refund

string

None.

accessToken

string

None.

bioCode

string

None.

Body Parameters

None.

Response Information

Resource Description

The refundId if success, otherwise errors. You can use the refundId to capture the initiated refund, query refund details or cancel a refund

PosRefundCreateViewModel
NameDescriptionTypeAdditional information
refundId

string

None.

success

None.

Response Formats

application/xml, text/xml

Sample:
<PosRefundCreateViewModel 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>
  <refundId>sample string 1</refundId>
</PosRefundCreateViewModel>

application/json, text/json

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