Skip to navigation
Overview

API reference

Every endpoint available to a Shimi merchant, with example responses for success and error cases.
View as Markdown

Base URL

https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1

Authentication: send Authorization: Bearer <accessToken> on every request except Generate Access Token and Refresh Access Token. See the Quickstart.

Sections

SectionWhat it covers
AuthenticationGet and refresh access tokens
CustomersOnboard BVN-verified customers and create their dedicated bank accounts
Customer TransactionsInbound transactions on your customers’ dedicated accounts
Virtual AccountsOne-time, amount-locked accounts for collecting a single payment
Settlement & PayoutsYour wallet balances, bank account validation and payouts
Corporate AccountsOnboard registered businesses and create their bank sub-accounts
CryptoDeposit addresses, crypto deposits and sending crypto out
Card IssuingIssue and manage prepaid cards
Airtime, Data & Bills (VTU)Airtime, data, electricity and cable TV payments
Webhooks You’ll ReceivePayloads Shimi sends to your server

Read before you integrate