Within Equity – Jenga Docs

Within Equity Bank

Test URL

POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/internalBankTransfer

Live URL

POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/remittance/internalBankTransfer

Move Funds Within Equity Bank 🏦 Across Kenya, Uganda, Tanzania, Rwanda & South Sudan.

📘 Equity Bank's Presence

This web service covers all 6 countries (KE, RW, UG, TZ, DRC, SS) in which Equity Bank operates in.

200 Success Response Schema

Field Name	Field Type	Field Description
`status`	`bool`	Response status
`code`	`number`	Response code
`message`	`string`	Response message
`data.transactionId`	`string`	unique transaction id
`data.status`	`string`	transaction status

Example Request

⚠️

In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.

Signature Formulae e.g. 00013XXXX6836500.00KES192112602006

source.accountNumber+transfer.amount+transfer.currencyCode+transfer.reference

Request Parameters

Field Name	Data Type	Required	Description
Source Fields
`source.countryCode`	`string`	Yes	The country code of the sender's bank account (e.g., "KE", "UG").
`source.name`	`string`	Yes	The full name of the account holder (e.g., "John Doe").
`source.accountNumber`	`string`	Yes	The sender's bank account number (e.g., "00013XXXX6836").
Destination Fields
`destination.type`	`string`	Yes	The type of destination (e.g., "bank").
`destination.countryCode`	`string`	Yes	The country code for the recipient's bank account (e.g., "KE").
`destination.name`	`string`	Yes	The full name of the recipient (e.g., "Tom Doe").
`destination.accountNumber`	`string`	Yes	The recipient's bank account number (e.g., "00201XXXX4605").
Transfer Fields
`transfer.type`	`string`	Yes	The type of transfer (e.g., "EFT").
`transfer.amount`	`string`	Yes	The amount of money to be transferred (e.g., "500.00").
`transfer.currencyCode`	`string`	Yes	The currency code for the transfer amount (e.g., "KES").
`transfer.reference`	`string`	Yes	A unique reference identifier for the transaction (e.g., "192112602006").
`transfer.date`	`string`	Yes	The date of the transaction (YYYY-MM-DD format, e.g., "2023-10-13").
`transfer.description`	`string`	Yes	Additional remarks about the transaction (e.g., "Some remarks here").
Headers
`Authorization`	`string`	Yes	Bearer token for authentication (replace `{access_token}` with a valid token).
`Content-Type`	`string`	Yes	Media type of the resource (should be `application/json`).
`signature`	`string`	Yes	A cryptographic signature for request integrity.

Example Request

curl -X POST \
	-d '{
      "source": {
          "countryCode": "KE",
          "name": "John Doe",
          "accountNumber": "00013XXXX6836"
      },
      "destination": {
          "type": "bank",
          "countryCode": "KE",
          "name": "Tom Doe",
          "accountNumber": "00201XXXX4605"
      },
      "transfer": {
          "type": "EFT",
          "amount": "500.00",
          "currencyCode": "KES",
          "reference": "192112602006",
          "date": "2023-10-13",
          "description": "Some remarks here"
      }
}'  \
	-H 'Authorization: Bearer {{access_token}}'  \
	-H 'Content-Type: application/json'  \
	-H 'signature: {{signature}}'  \
	-L 'https://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance'

Example Response

{
    "status": true,
    "code": 0,
    "message": "success",
    "reference": "192112602006",
    "data": {
        "transactionId": "5414",
        "status": "SUCCESS"
    }
}

Account Inquiry - All Accounts Mobile Wallets