Account Payment Remove Blockage

Service Description

Remove Blockage Service is used to remove the blockage and the order amount will not be transferred into the firm account. It may be used for the stock management, by the firm. If a product/service is unavailable to sell out, firm is able to remove the blockage and rollback the payment process, despite the customer approves the payment. After all, the amount will remain in the customer’s account.

To be able to consume this service, BlockageInd field should be filled with the value ‘Y’ at the Create QR service, for the desired order.

This API is in the cash management category

API Profile

Attribute

Value
Name Remove Blockage
Version V1
Synopsis Remove Blockage Service
Description Creates UID which represents order information
Pre-Conditions HTTP POST method is allowed only in Remove Blockage service.
Authentication OAuth 2.0 with Client Credentials

Before your application can access the API, it must obtain a new access token for each request. The access token can be used only one time.

Endpoint Definition

Remove Blockage API’s development live and mock environments routing data.

EndPoint / DEVELOPMENT SANDBOX SERVICE
URI /cashmanagement/v1/removeBlockage
Base URL https://apis.garantibbva.com.tr


Technology

Technology Stack / DESIGN TIME
Property Value
HTTP Call Method POST
Response Content Type application/json


Request

HTTP POST method is allowed only in Remove Blockage service.

Arguments

The list of arguments by the Remove Blockage service to be invoked.

Request Fields Type Description Obligation
OrderID String The order/invoice number which is unique Mandatory

 

​Sample request

  {
    "OrderID":"BlokeDeneme1"
  }

Response

The Remove Blockage service returns the result.

Sample response

  "result": {
    "code": 202,
    "info": "The request has been received"
  },
  "response":{
    "resultCode":"B001",
    "resultMessage":"İşleminiz tamamlandı"
  }
Return Codes & Error Handling

Response codes from Remove Blockage request

Code

Description

Type
200 OK SUCCESS
405 {http.method} Method Not Allowed CALL METHOD ERROR
400 Invalid Request MISSING PARAMETERS
401 Invalid Credentials UNAUTHORIZED
429 API plan limit exceeded RATE LIMITING
500 Internal Server Error SYSTEM ERROR

Return Messages

CODE

RETURN RESPONSE
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
      }
    }
401 
  {
    "result": {
      "code": 401,
      "info": "Invalid Credentials"
      }
    }
405 
  {
    "result": {
      "code": 405,
      "info": "POST Method Not Allowed"
      }
    }
429 
  {
    "result": {
      "code": 429,
      "info": "API plan limit exceeded"
      }
    }
500 
  {
    "result": {
      "code": 500,
      "info": "Internal Server Error"
      }
    }

 

Response Messages

CODE

RETURN RESPONSE
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H009",
      "resultMessage":"Bloke zaten iptal edilmiş."
    }
  }
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H010",
      "resultMessage":"Bloke iptali için statü uygun değil."
    }
  }
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H001",
      "resultMessage":"Kurum kodu dolu olmalıdır."
    }
  }
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H011",
      "resultMessage":"Sipariş/Fatura numarası dolu olmalıdır."
    }
  }
400 
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H012",
      "resultMessage":"Sipariş numarası dolu olmalıdır."
    }
  }