Fetch a Team (Account)

GET

/api/v2/account/{account_id}

const url = 'https://api.payhero.africa/api/v2/account/63';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.payhero.africa/api/v2/account/63 \
  --header 'Authorization: Basic <credentials>'

Returns a single Team by id.

Authorizations

basicAuth

Parameters

Path Parameters

account_id

required

integer

Example

Responses

200

The Team.

application/json

object

account

A Team — an isolated Account with its own scoped wallet, payment channels, KYC and members.

object

integer

organization_id

integer

name

string

description

string

currency

Derived from the account phone number’s country at creation.

string

number

string

email

string

status

string

account_type

string

kyc_tier

integer

kyc_verified

boolean

service_wallet_balance

number

logo

string

theme_color

string

notify_amount

integer

created_at

string format: date-time

updated_at

string format: date-time

Example

{
  "account": {
    "id": 63,
    "organization_id": 9,
    "name": "Vendor A",
    "description": "WiFi vendor onboarded via our platform",
    "currency": "KES",
    "number": "254711000111",
    "email": "vendor-a@acme.co",
    "status": "active",
    "account_type": "prepaid",
    "kyc_tier": 1,
    "kyc_verified": false,
    "service_wallet_balance": 0,
    "theme_color": "#0A7C4A",
    "notify_amount": 500
  }
}

401

Missing or invalid Basic auth credentials.

application/json

object

error_code

string

error_message

string

status_code

integer

Example

{
  "error_code": "invalid_argument",
  "error_message": "the transaction amount is insufficient as it wont cater for cost: (4.62)",
  "status_code": 400
}