API method index

Every InnBucks Merchant API method, in alphabetical order.

Method HTTP Path Success Reference Guide
Account statement POST /api/account/fullStatement 00 7.11 12.6
Bank change POST /api/transaction/bankChange 00 7.9 6.5
Code inquiry POST /api/code/inquiry 00 + status 7.4 5.4
Deposit POST /api/transaction/deposit 00 7.6 6.2
Deposit inquiry POST /bank/api/transaction/inquiry 00 + details.responseCode 7.7 6.3
Generate code (payment) POST /api/code/generate 00 7.3 5.1
Generate code (withdrawal) POST /api/code/generate 00 7.3 6.1
Linked account inquiry GET /api/v1/account/msisdn/{msisdn}/details 000 7.5 6.2
Login POST /auth/third-party 00 + accessToken 7.2 4.1
Response code list GET /api/file/response-codes 2xx 7.12 8.2
Reversal (deposits only) POST /api/transaction/reversal/v2 00 7.8 6.4
Utility payment POST /api/utility/provider/payment 00 7.10 7.10

And the deep link, which is not an API call:

  Format
Test zw.co.innbucksnova.test://purchase?paymentToken={code}
Production com.innbucks.customer://purchase?paymentToken={code}

The client methods for each language:

API method PHP / Laravel Node.js Python
Login token() login() login()
Generate code generateCode() generateCode() generate_code()
Code inquiry inquireCode() inquireCode() inquire_code()
Linked account inquiry linkedAccount() linkedAccount() linked_account()
Deposit deposit() deposit() deposit()
Deposit inquiry depositInquiry() depositInquiry() deposit_inquiry()
Reversal reverseDeposit() reverseDeposit() reverse_deposit()
Bank change bankChange() bankChange() bank_change()
Utility payment utilityPayment() utilityPayment() utility_payment()
Account statement statement() statement() statement()
(helper) deep link deepLink() deepLink() deep_link()
(helper) wait for a code PollInnBucksCode job waitForCode() wait_for_code()

This page is generated from section 15 of the README in README.md. Spotted something wrong? Open an issue.


Back to top

MIT licensed. Written and maintained by John Mugabe under 67even. Independent and community-maintained - not affiliated with or endorsed by InnBucks MicroBank Limited. "InnBucks" and the InnBucks logo belong to their owner.