Unblock Amount

Last changes: 10-28-2022

This interface method is used to unblock a previously blocked payment from an e-wallet account to a merchant and optionally payout the amount to the used stored payment option.

Request parameters

partnerReference

String Length: 64 Required

Partner service call identifier.

uniqueReference

String Length: 36 Required

uniqueReference of a blocked transaction.

refundAmount

Boolean Required

Defines if the unblocked amount should be refunded to the used payment option.

localDate

YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime

HHMMSS Length: 6 Required

The current time of the caller.

Path:: POST {baseURL}/payment/{uniqueReference}/kc-unblock
Header:: Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
   "partnerReference": "1234567",
   "refundAmount": true,
   "modifiedUsage": "Unblocked by the merchant.",
   "localDate": "2019-01-11",
   "localTime": "145752"
}

Response parameters

partnerReference

String Length: 64

partnerReference same as in the Request.

uniqueReference

String Length: 36

uniqueReference of a blocked transaction.

customerAccno

String Length: 255

Customer account number.

refundReference

String Length: 36

Unique transaction reference of the transaction assigned by KontoCloud upon refund.

refundStatusCode

String Length: 10

Refund transaction status code. Refer to Transaction Status in the Lookups.

refundStatusReason

String Length: 255

refundStatusReason

presentationAmount

Decimal Length: 18.2

The amount which is unblocked.

presentationCurrCode

String Length: 3

The 3-letter currency code associated with the unblocked amount.

processedAmount

Decimal Length: 18,2

The amount returned by the acquirer after processing.

localDate

YYYY-MM-DD Length: 10

The current date of the caller.

localTime

HHMMSS Length: 6

The current time of the caller.

sysDate

YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime

HHMMSS Length: 6

The current time of the KontoCloud server

responseCode

String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription

String Length: 512

The response description. See Response Codes in the Lookups.

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
  "uniqueReference": "53234567643",
  "customerAccno": "222123456", 
  "merchantAccno": "444123456", 
  "presentationAmount": 100, 
  "presentationCurrCode": "EUR", 
  "refundReference": "949596919292", 
  "refundStatusCode": "CAPTURED", 
  "refundstatusReason": "",
  "processedAmount": 100,
  "processedCurrCode": "EUR",
  "localDate": "2014-03-12",
  "localTime": "163835",
  "sysDate": "2014-03-12",
  "sysTime": "153837",
  "responseCode": "0000", 
  "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

Previous

Next