Skip to main content

Unblock Amount

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

partnerReferenceString64RequiredPartner service call identifier.
uniqueReferenceString36RequireduniqueReference of a blocked transaction.
refundAmountBooleanRequired-Defines if the unblocked amount should be refunded to the used payment option.
localDateYYYY-MM-DD10RequiredThe current date of the caller.
localTimeHHMMSS6RequiredThe 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

partnerReferenceString64partnerReference same as in the Request.
uniqueReferenceString36uniqueReference of a blocked transaction.
customerAccnoString255Customer account number.
refundReferenceString36Unique transaction reference of the transaction assigned by KontoCloud upon refund.
refundStatusCodeString10Refund transaction status code. Refer to Transaction Status in the Lookups.
refundStatusReasonString255refundStatusReason
presentationAmountDecimal18.2The amount which is unblocked.
presentationCurrCodeString3The 3-letter currency code associated with the unblocked amount.
processedAmountDecimal18,2The amount returned by the acquirer after processing.
localDateYYYY-MM-DD10The current date of the caller.
localTimeHHMMSS6The current time of the caller.
sysDateYYYY-MM-DD10The current date of the KontoCloud server.
sysTimeHHMMSS6The current time of the KontoCloud server.
responseCodeString4The response code. See Response Codes in the Lookups.
responseDescriptionString512The response description. See Response Codes in the Lookups.

Status Code:

200 (OK)

Header:

Content-Type: text/plain
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"
}
}