production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/transactions/{trans_ref_id}
get /transactions/{trans_ref_id}
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth2
oauth2
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/h2h_auth/token
Scopes
enquiry:read
enquiry:read
trans_ref_id
Required in path
string
The reference ID of transaction.
{
"maxLength": 10
}MsgId
Required in header
string
Unique Id sent from client. Value should be a unique identifier of the request in UUID format.
{
"maxLength": 50
}Accept
Optional in header
string
application/json
200
200 OK
422
Error Response
500
Internal Server Error
Example Request
Example Response
GET https://sandboxapi.rakbank.ae/sb/api/v1/h2h/transactions/{trans_ref_id}
Try this operation
Definitions
{
"properties": {
"unique_tran_ref_number": {
"type": "string",
"minLength": 0,
"maxLength": 21,
"description": "The unique transaction reference number",
"example": "123456789"
},
"transaction_date": {
"type": "string",
"minLength": 0,
"maxLength": 10,
"description": "The date of the transaction"
},
"status_message": {
"type": "string",
"minLength": 0,
"maxLength": 50,
"description": "The status message of transaction",
"example": "Successful"
},
"xf_req_id": {
"type": "string",
"minLength": 0,
"maxLength": 10,
"description": "The internet banking reference number",
"example": "862677"
},
"host_txn_id": {
"type": "string",
"minLength": 0,
"maxLength": 30,
"description": "The host transaction reference number",
"example": "000000000986"
},
"status": {
"type": "string",
"minLength": 0,
"maxLength": 3,
"description": "The status of the transaction. S - Success, F- Failure, P - Processing",
"example": "S"
},
"ccn_status": {
"type": "string",
"minLength": 0,
"maxLength": 1,
"description": "The outward payment status. Valid value will be “S” if credit is successful and “F” if the credit is failure.",
"example": "F"
},
"ccn_fail_reason": {
"type": "string",
"minLength": 0,
"maxLength": 100,
"description": "Description of the CCN failure. Applicable only if ccn_status is “F”",
"example": "Insufficient balance"
},
"failure_reason": {
"type": "string",
"minLength": 0,
"maxLength": 64,
"description": "The reason for the failure",
"example": "Insufficient balance"
}
},
"additionalProperties": false
}
Response in case of error
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status"
},
"response_code": {
"type": "string",
"description": "API specific error code"
},
"property": {
"type": "string"
},
"response_message": {
"type": "string",
"description": "brief type of the error",
"example": ""
},
"description": {
"type": "string",
"description": "detailed description of the error"
}
},
"additionalProperties": false,
"required": [
"response_code",
"status",
"response_message"
]
}