production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/statement
post /statement
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
statement:read
statement:read
MsgId
Required in header
string
Unique Id sent from client. Value should be a unique identifier of the request in UUID format.
statement_request
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
422
Error Response
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/h2h/statement
Try this operation
Definitions
{
"properties": {
"customer_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The CIF ID of the customer.",
"example": "2097111"
},
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 24,
"description": "The account ID for which the statement is to be retrieved.",
"example": "0372097111001"
}
},
"additionalProperties": false,
"required": [
"account_id",
"customer_id"
]
}
{
"properties": {
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 24,
"description": "The customer's account id for which transaction is initiated",
"example": "0372097111001"
},
"branch_id": {
"type": "string",
"minLength": 1,
"maxLength": 9,
"description": "The branch id",
"example": "037"
},
"interest_rate": {
"type": "string",
"description": "The interest rate for the month",
"example": "0"
},
"effective_interest_rate": {
"type": "string",
"description": "The effective interest rate for CASA, deposit account. It will be used to get the average Interest rate on the HIO loan account for the statement period",
"example": "0"
},
"opening_balance": {
"type": "string",
"description": "The opening balance for CASA, deposit, HIO, Loan account.",
"example": "AED|247,813.20"
},
"closing_balance": {
"type": "string",
"description": "The closing balance of the account for CPF statement. Applicable for CASA, Deposit, HIO account.",
"example": "AED|246,882.42"
},
"total_withdrawal": {
"type": "string",
"description": "The total of withdrawal amount for CPF statement. Applicable for CASA, Deposit account.",
"example": "AED|930.78"
},
"total_deposits": {
"type": "string",
"description": "The total deposit amount for CPF statement. Applicable for CASA, Deposit account.",
"example": "0.00"
},
"total_ledger_fee": {
"type": "string",
"description": "The total ledger fees of CASA account for CPF statement",
"example": "0.0"
},
"interest_type": {
"type": "string",
"minLength": 0,
"maxLength": 20,
"description": "The interest type of CASA account for CPF statement",
"example": "Fixed"
},
"accrued_interest": {
"type": "string",
"description": "The entire interest accrued for the savings conventional account.",
"example": "AED|0.0"
},
"iban_number": {
"type": "string",
"minLength": 0,
"maxLength": 34,
"description": "The IBAN number of deposit account.",
"example": "AE560400000372097111001"
},
"account_type": {
"type": "string",
"minLength": 0,
"maxLength": 100,
"description": "The scheme code description for deposit account type."
},
"account_currency": {
"type": "string",
"description": "The supported currency for the account",
"example": "AED"
},
"overdue_charges": {
"type": "string",
"description": "The overdue charges",
"example": "AED|0.0"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/transaction_details"
},
"description": ""
},
"pagination": {
"$ref": "#/definitions/pagination"
}
},
"additionalProperties": true,
"required": [
"account_id",
"branch_id"
]
}
{
"properties": {
"transaction_serial_no": {
"type": "string",
"minLength": 0,
"maxLength": 32,
"description": "Serial number of the transaction",
"example": "1000"
},
"transaction_id": {
"type": "string",
"minLength": 0,
"maxLength": 32,
"description": "Transaction id",
"example": "S25901533"
},
"transaction_date": {
"type": "string",
"description": "Transaction date",
"example": "2025-01-29"
},
"posted_date": {
"type": "string",
"description": "Transaction posted date",
"example": "2025-01-29"
},
"value_date": {
"type": "string",
"description": "Value date of the transaction",
"example": "2025-01-29"
},
"transaction_desc": {
"type": "string",
"minLength": 0,
"maxLength": 1000,
"description": "Transaction description, lines of narration are be delimited by \"|\" (pipe character)",
"example": "TRANSFER -CREDIT||FOR RMT2|||"
},
"transaction_type": {
"type": "string",
"minLength": 0,
"maxLength": 2,
"description": "The type of the transaction, 04- Credit & 05-Debit",
"example": "04"
},
"transaction_cheque_no": {
"type": "string",
"minLength": 0,
"maxLength": 16,
"description": "Transactin cheque number",
"example": "654321"
},
"transaction_amount": {
"type": "string",
"description": "Transaction amount",
"example": "1000"
},
"transaction_currency": {
"type": "string",
"minLength": 0,
"maxLength": 3,
"description": "Transaction currency",
"example": "AED"
},
"transaction_balance": {
"type": "string",
"description": "The balance at the time of transaction posting",
"example": "49000"
},
"org_amount": {
"type": "string",
"description": "Reference amount for transaction",
"example": "1000"
},
"org_currency": {
"type": "string",
"minLength": 0,
"maxLength": 3,
"description": "Reference currency for transaction",
"example": "AED"
},
"account_number": {
"type": "string",
"minLength": 0,
"maxLength": 24,
"description": "The account number associated with the transaction. It will either represent the CASA account for which the transaction was retrieved or the FFD account linked to the respective account.",
"example": "0122519981001"
}
},
"additionalProperties": false,
"required": [
"transaction_date",
"transaction_type",
"transaction_amount",
"transaction_currency"
]
}
{
"properties": {
"number_of_records": {
"type": "integer",
"description": "The number of records returned.",
"example": "10",
"format": "int32"
},
"has_more_records": {
"type": "string",
"description": "A indicator that signifies whether additional records exist beyond those included in the current response.",
"example": "N"
}
},
"additionalProperties": false
}
Response in case of error
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status",
"example": "422"
},
"response_code": {
"type": "string",
"description": "API specific error code",
"example": "422010"
},
"property": {
"type": "string",
"description": "",
"example": "customer_id"
},
"response_message": {
"type": "string",
"description": "breif details of the error",
"example": "Record Not Found"
},
"description": {
"type": "string",
"description": "detailed description of the error",
"example": "customer_id not found"
}
},
"additionalProperties": false,
"required": [
"response_message",
"response_code",
"status"
]
}