Account Cashin - IHELA OFFICIAL DOCS

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

credit_account

string

required

The account that will receive the money

credit_bank

string

required

The bank of the account that will receive

credit_account_holder

string

required

The account holder

amount

integer

required

The amount to be sent

merchant_reference

string

required

The merchant reference generated in your system

description

string

required

A short description

pin_code

string

required

4 digits pin code

currency

string

required

Example

{
    "credit_account": "0000000016-01",
    "credit_bank": "MF1-0001",
    "credit_account_holder": "PIERRE CLAVER KOKO BANYWERHA",
    "amount": 500,
    "merchant_reference": "123456",
    "description": "Payment Product 0098434",
    "pin_code": "1234",
    "currency": "BIF"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1:8081/api/v2/payments/cash-in/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "credit_account": "0000000016-01",
    "credit_bank": "MF1-0001",
    "credit_account_holder": "PIERRE CLAVER KOKO BANYWERHA",
    "amount": 500,
    "merchant_reference": "123456",
    "description": "Payment Product 0098434",
    "pin_code": "1234",
    "currency": "BIF"
}'

Responses

🟢200OK

application/json

Body

response_code

string

required

Possible response codes :
"00" : Success
"01" : General error
"02" : Invalid password
"03" : Object not found
"04" : Invalid object
"05" : Insuffiscient funds
"06" : User auth rejected
"07" : Other internal connection error
"400" : Bad request
"404" : Not found
"500" : Internal error

response_data

object

required

reference

string

required

bank_reference

string

required

pending_id

integer

required

date

string

required

is_partial

boolean

required

response_message

string

required

success

boolean

required

Example

{
    "response_code": "00",
    "response_data": {
        "reference": "29032360510975",
        "bank_reference": "123456",
        "pending_id": 975,
        "date": "2023-03-29T09:16:24.396951Z",
        "is_partial": false
    },
    "response_message": "Transaction successfully done. Reference: 29032360510975 >> mTSF.3000100-756.3000101-2108",
    "success": true
}