Account Payment Status Inquiry

Service Description

StatusInquiry Service is used to know the current situation of the order. The firm may be informed of every step of the payment process, by using this service.

This API is in the cash management category

API Profile

Attribute

Value

Name Status Inquiry
Version V1
Synopsis Status Inquiry Service
Description Creates UID which represents order information
Pre-Conditions HTTP POST method is allowed only in Status Inquiry 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/StatusInquiry
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 Status Inquiry service.

Arguments

The list of arguments by the Status Inquiry service to be invoked.

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

 

​Sample request

  {
    "OrderID":"StatusInquiry"
  }
    

Response

The status inquiry service returns the current status of the order and the payment process.

Sample response

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

Response codes from Status Inquiry 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":"H001",
      "resultMessage":"Kurum kodu dolu olmalıdır."
    }
  }
400
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H002",
      "resultMessage":"Ödeme tipi dolu olmalıdır."
    }
  }
400
  {
    "result": {
      "code": 400,
      "info": "Invalid Request"
    },
    "response":{
      "resultCode":"H011",
      "resultMessage":"Sipariş/Fatura numarası dolu olmalıdır."
    }
  }