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

engageSPARK Top-Up API

The Top-Up API from engageSPARK — 3 operation(s) for top-up.

engageSPARK Top-Up API is one of 7 APIs that engageSPARK publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Top-Up. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.engagespark.com.

3 operations 3 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.engagespark.com
Authentication
HTTP Token
License
Terms of Service
Resource Areas
1

Authentication & Security 1

engageSPARK Top-Up API declares 1 security scheme for authenticating requests. It uses HTTP token authentication (apiToken). By default, every request must be authenticated.

  • apiToken — Token based HTTP authentication. Use the header "Authorization". The value must be the word "Token" followed by your token. For example: "Authorization: Token…

Paths & Operations 3

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

Top-Up 3
POST
/v1/organizations/{orgId}/topup/
Send airtime top-up to a phone number
sendOrgTopup 1 param body → 200202400401
GET
/v1/organizations/{orgId}/topups/
List Top-Ups for an organization
getOrgTopupsList 9 params → 200401
GET
/v1/organizations/{orgId}/topups/{topupId}/
Get a single Top-Up by ID
getOrgTopups 2 params → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is schema_topup (10 properties). Each schema is shown below with its type and property counts.

schema_topup
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagespark-top-up-api-openapi.yml Raw ↑

Other APIs engageSPARK publishes across the network.

engageSPARK Balance API
engageSPARK Campaigns API
engageSPARK Contacts API
engageSPARK Files API
engageSPARK SMS API
engageSPARK WhatsApp API