Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Howler Cashout API

The Cashout API from Howler — 4 operation(s) for cashout.

Howler Cashout API is one of 17 APIs that Howler publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cashout. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 3.6.1.

Requests are made against a single base URL, https://{defaultHost}/api/v3/consumer_portal.

5 operations 4 paths 3 schemas 1 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.6.1
Base URL
https://www.howler.co.za/api/v3/consumer_portal
Authentication
OAuth 2.0, HTTP Bearer, API Key, HTTP Bearer, API Key, HTTP Basic, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 8

Howler Cashout API declares 8 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. It accepts HTTP bearer tokens (oauth2) (bearer_header). An API key is passed in the query as bearer_token (bearer_param). It accepts HTTP bearer tokens (JWT) (jwt_header). An API key is passed in the query as bearer_token (jwt_param). It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as x-auth-token (api_key). It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • oauth2 — OAuth2 authentication for third-party applications
  • jwt_header — JWT token obtained from basic authentication login
  • jwt_param — JWT token as query parameter (alternative to Authorization header)
  • basic_auth — Basic authentication with email and password
  • api_key — API key authentication
  • bearer_auth — JWT token authentication

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Cashout 5
POST
/cashless_tags/{cashless_tag_uid}/cashout
check event (1)
updateConsumerCashoutEvent 1 param body → 200400404
PUT
/cashless_tags/{cashless_tag_uid}/cashout/{cashless_tag_pairing_id}/amounts
cashout amounts (2)
updateConsumerCashoutAmounts 2 params → 200400404
PUT
/cashless_tags/{cashless_tag_uid}/cashout/{cashless_tag_pairing_id}/confirmation
confirm cashout (3)
updateConsumerCashoutConfirm 2 params → 200400404
GET
/cashless_tags/{cashless_tag_uid}/cashout/{cashless_tag_pairing_id}/web/amounts
view amounts
showCashlessTagCashoutAmountWeb 2 params → 200
PUT
/cashless_tags/{cashless_tag_uid}/cashout/{cashless_tag_pairing_id}/web/amounts
confirm amounts
updateCashlessTagCashoutAmountWeb 2 params → 302

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CashlessTagPairing (8 properties), CashlessTagBalance (6 properties), User (5 properties). Each schema is shown below with its type and property counts.

CashlessTagPairing
object
8 properties 7 required
User
object
5 properties 5 required
CashlessTagBalance
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

howler-cashout-api-openapi.yml Raw ↑

Other APIs Howler publishes across the network.

Howler Artists API
Howler Assign Ticket API
Howler Bank Account API
Howler Basic Authentication API
Howler Cashless Tags API
Howler Email OTP API
Howler Events API
Howler OAuth API
Howler Third Party OAuth API
Howler Tickets API
Howler Top Up API
Howler Top Up Cashless Tag API