Skip to main content
GET
/
v1
/
accounts
List accounts
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fingopay.io/v1/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "status": "success",
  "message": "Accounts fetched",
  "data": {
    "items": [
      {
        "type": "collections",
        "currency": "KES",
        "available": 9876543,
        "pending": 0,
        "status": "active",
        "default": true,
        "accountNo": "ACC-123456",
        "name": "Main Collections",
        "hostType": "fingo",
        "bankName": "Choice Bank",
        "bankCode": "80100",
        "branchCode": "001",
        "swiftCode": "CHKEKENX"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. Example: Authorization: Bearer sk_live_...

Query Parameters

type
enum<string>

Filter accounts by type. Can be combined with scope.

Available options:
collections,
payouts
scope
enum<string>

Filter accounts by shortcode scope. Use default for accounts where shortcodeId is absent, or shortcode for accounts where shortcodeId is present. Can be combined with type.

Available options:
default,
shortcode

Response

Accounts fetched successfully

status
string
required
Example:

"success"

message
string
required
Example:

"Accounts fetched"

data
object
required