API developer
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/transactions
post /transactions
Post new transaction
This endpoint will used used by H2H partners to post a new transaction
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/h2h_auth/token
Scopes
transaction:write
transaction:write
MsgId
Required in header
string
Unique Id sent by client. Value should be a unique identifier of the request in UUID format.
transaction_posting_request
Required in body
object
request body
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/h2h/transactions
Try this operation
Definitions
{
"properties": {
"txn_type_identifier": {
"type": "string",
"example": "WBP",
"description": "The field to specify the type of transaction."
},
"debit_account_number": {
"type": "string",
"example": "0024116715123",
"description": "Account from where the transaction amount will be deducted"
},
"beneficiary_nick_name": {
"type": "string",
"example": "EZ Corp",
"description": "Personalized name for a beneficiary"
},
"credit_account_number": {
"type": "string",
"example": "0024116715100",
"description": "Account where the transaction amount will be credited"
},
"remitting_currency": {
"type": "string",
"example": "AED",
"description": "Currency in which the receiver will receive the amount. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"txn_currency": {
"type": "string",
"example": "AED",
"description": "Transaction currency"
},
"txn_amount": {
"type": "string",
"example": "121.23",
"description": "Amount to be transferred"
},
"charge_indicator": {
"type": "string",
"example": "Shared",
"description": "The field specifies whether the transaction fees will be borne by the sender, the recipient, or shared between both parties. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"beneficiary_resident_country": {
"type": "string",
"example": "India",
"description": "Resident country of Beneficiary. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"reason": {
"type": "string",
"example": "Own account transfer",
"description": "Code explaining the reason for the transaction. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"details_of_payment_1": {
"type": "string",
"description": "Additional remarks about the payment."
},
"details_of_payment_2": {
"type": "string",
"description": "Unique reference number to identify the transaction related traces in all the system."
},
"details_of_payment_3": {
"type": "string",
"description": "This field holds the signing mandate roles."
},
"beneficiary_name": {
"type": "string",
"example": "Jane Doe",
"description": "The name of the beneficiary."
},
"beneficiary_bank_country": {
"type": "string",
"example": "India",
"description": "The country code of the beneficiary’s bank. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"beneficiary_bank_name": {
"type": "string",
"example": "HDFC",
"description": "The name of the beneficiary’s bank. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"beneficiary_bank_branch": {
"type": "string",
"example": "Silver Park",
"description": "The branch of the beneficiary’s bank. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"beneficiary_bank_city": {
"type": "string",
"example": "Mumbai",
"description": "The city where the beneficiary’s bank is located. Mandatory field in case of Within UAE, Outside UAE Transaction."
},
"beneficiary_bank_swift": {
"type": "string",
"description": "The SWIFT code of the beneficiary’s bank. In international required to route transaction to correct bank."
},
"intermediary_bank_name": {
"type": "string",
"example": "ICICI",
"description": "The name of the intermediary bank. bank that acts a middleman to process international payments between the sender's and beneficiary's banks. needed when there is no direct relationship between the sender's and beneficiary's banks. Not needed for domestic."
},
"intermediary_bank_swift": {
"type": "string",
"description": "The SWIFT code of the intermediary bank, identify the intermediary bank in the payment chain."
},
"unique_txn_ref_no": {
"type": "string",
"example": "UNIQ12345",
"description": "A unique reference number"
},
"c_cif": {
"type": "string",
"example": "123456",
"description": "Corporate CIF"
},
"r_cif": {
"type": "string",
"example": "1234567",
"description": "Retail CIF"
},
"org_id": {
"type": "string",
"example": "org12345",
"description": "Organization id"
},
"free_field_1": {
"type": "string",
"example": "Free field 1",
"description": "Free Field 1"
},
"free_field_2": {
"type": "string",
"example": "Free field 2",
"description": "Free Field 2"
},
"free_field_3": {
"type": "string",
"example": "Free field 3",
"description": "Free Field 3"
},
"free_field_4": {
"type": "string",
"example": "Free field 4",
"description": "Free Field 4"
},
"free_field_5": {
"type": "string",
"example": "Free field 5",
"description": "Free Field 5"
}
},
"additionalProperties": false,
"required": [
"txn_type_identifier",
"debit_account_number",
"beneficiary_nick_name",
"credit_account_number",
"txn_currency",
"txn_amount",
"beneficiary_name",
"unique_txn_ref_no",
"org_id",
"c_cif",
"r_cif"
]
}
{
"properties": {
"db_reference_id": {
"type": "string",
"example": "123456789",
"description": "Reference id of the transaction."
},
"status": {
"type": "string",
"example": "COMPLETED",
"description": "Current status of transaction."
}
},
"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"
]
}