Purpose of this Document

This document provides corporate partners with a clear, standardised guide to integrating with the Flash Partner Support API for certain read-only information to display on corporate's internal website or platform.

It describes available support-related endpoints, their use cases, request requirements, and response structures.

All information supplied in this API is the same as it displays in the CSP. Corporate teams are still encouraged to keep using CSP where possible.

1. Overview

1.1 What this API does

The Partner Support API enables corporate partners that have their own internal platform front end to request and retrieve support and operational information from Flash Aggregation directly instead of requiring CSP login.

The API is designed to support operational, reconciliation, and customer support use cases.

This API supports read-only queries for:

Account and wallet balances per trading account
Transaction lookups:
- V4 API transacted transactions performed per trading account
- 1Voucher status query for any Flash 1Voucher
- Exclusive voucher lookup for Exclusive voucher owners

1.2 Intended Audience

This API documentation is intended for:

Developers integrating Flash v4 api services to connect to their own internal portal
Corporate Managers, Finance and Support teams working on their internal platform for information to assist customers and their finances.

2. Authentication

2.1 Authentication Method

Flash will connect Corporates via Flash's Glu Control on staging.

When staging is approved, Production credentials will be created in Glu Control and supplied.

Partners currently using WS02 for v4Api integration, will need to migrate to Glu Control.

All API requests require Bearer Token authentication. Requests without a valid token will be rejected.

Validity: The token is valid for 60 minutes (1 hour) before it expires and a new token is required.

Item	Description
Token type	Beare Token
Header	Authorization: Bearer {token}

Authentication details, token URLs, and credentials are provided separately by Integrations.

3. Error Handling (Standard)

3.1 HTTP Status Codes

Status Code	Meaning
200	Request processed successfully
400	Invalid request or missing parameters such as missing trading account number, Missing serial number, Invalid search type, Empty search field
401	Authentication failed such as bearer token, has the token expired, is the incorrect environment being used.
500	Internal server error: Capture request, timestamp, response, escalate to support.

3.2 API Response Codes

Most responses include a ResponseCode and ResponseMessage to indicate business-level success or failure.

For any failures, it's recommended to share both the response code and message to Flash Support.

Field	Description
ResponseCode	Numeric business-level result confirms what failed/ succeeded
ResponseMessage	Human-readable explanation confirming why it failed / succeeded.

4. API Reference – Topic Structure

Each Topic represents a logical support capability exposed through the Partner Support API.

4.1 Balance Status Check

4.1.1 Topic Overview

This topic allows corporates to retrieve their v4 Api live wallet balances and credit information linked to a trading account.

4.1.2 Get Account Balance

Summary

Returns wallet(s) and credit balance for a given account number.

Balance Lookup Rate limit: 10 calls per minute.

Endpoint Details

Item	Value
HTTP Method	GET
URL	/account/balance
Production Base URL	https://api-integrations.flash.co.za/aggregation/support/1.0
Staging Base URL	https://aggregation-partner-support-api-staging.qa.flash.co.za

Request Parameters

Parameter	Type	Required	Description
AccountNumber	String	Yes	Trading account number to query
Reference	String	Yes	Guid reference number for caching

Response Fields

Field	Type	Description
AvailablePurchaseBalance	decimal	Funds the customer can spend right now taking in account purchase wallet and credit limits.
PurchaseBalance	decimal	Total prefunded purchase wallet balance for purchases and disbursements.
CreditLimit	decimal	Credit limit balance assigned to the account for additional spending should pre-funded purchase wallet run out.
RedemptionBalance	decimal	Balance available received from redemptions that Flash owes you as per settlement agreement.
ResponseCode	int	Business response code
ResponseMessage	string	Response message

Request example

{
"reference": "abcdefghij",
"accountNumber": "1234-abcd-5678-efgh"
}

{
"reference": "abcdefghij",
"accountNumber": "1234-abcd-5678-efgh"
}

{
"reference": "abcdefghij",
"accountNumber": "1234-abcd-5678-efgh"
}

Response Example

{
"availablePurchaseBalance": 15000.50,
"purchaseBalance": 20000.00,
"creditLimit": 50000.00,
"redemptionBalance": 3000.00,
"responseCode": 0,
"responseMessage": "Success"
}

{
"availablePurchaseBalance": 15000.50,
"purchaseBalance": 20000.00,
"creditLimit": 50000.00,
"redemptionBalance": 3000.00,
"responseCode": 0,
"responseMessage": "Success"
}

{
"availablePurchaseBalance": 15000.50,
"purchaseBalance": 20000.00,
"creditLimit": 50000.00,
"redemptionBalance": 3000.00,
"responseCode": 0,
"responseMessage": "Success"
}

Front end design example

Design suggestion only. These screens illustrate one way to present the Partner Support API Balance call.

4.2 Transaction Search

4.2.1 Topic Overview

This topic allows corporates to search for specific transaction performed by their trading account on v4api using references, serial numbers.

Only one transaction can be searched for at a time.

4.2.2 Search Transactions

Summary

Search for transactions the Trading Account processed in the v4Api based on provided search criteria.

Transactions lookup rate limit: 10 calls per minute.

Only 1 transaction can be searched for at a time.

Endpoint Details

Item	Value
HTTP Method	POST
URL	/transaction/search-transactions
Production Base URL	https://api-integrations.flash.co.za/aggregation/support/1.0
Staging Base URL	https://aggregation-partner-support-api-staging.qa.flash.co.za

Request Parameters

Parameter	Type	Required	Description
AccountNumber	string	Yes	Trading account number
SearchValue	string	Yes	Reference, serial, or transaction identifier
SearchType	int	Yes	1 = External Reference, 2 = Serial Number, 3 = Transaction ID
ProductGroup	string	Yes	Optional product group filter
Reference	string	Yes	Guid reference number for caching

Response Fields

Field	Type	Description
TransactionId	long	Unique transaction identifier
GrossValue	decimal	Gross transaction amount in ZAR Rands
TransactionReference	string	External reference supplied by Flash
Created	datetime	Transaction creation date
ProductCode	long	Product code
ProductGroup	string	Product group (end point)
ProductName	string	Product Name
VendorName	string	Vendor Name that performed the transaction
TransactionType	string	Transaction type (purchase, redemption, disbursement, cancellation etc.)
Status	string	Transaction status (Active, redeemed, expired, cancelled)
SerialNumber	string	Serial number supplied by Flash
MetaData	string	Additional metadata if available

Request Example

{
"accountNumber": "1234-abcd-5678-efgh",
"searchValue": "20260611111",
"searchType": 2,
"reference":"abcdefghij"
}

{
"accountNumber": "1234-abcd-5678-efgh",
"searchValue": "20260611111",
"searchType": 2,
"reference":"abcdefghij"
}

{
"accountNumber": "1234-abcd-5678-efgh",
"searchValue": "20260611111",
"searchType": 2,
"reference":"abcdefghij"
}

Response Example

{
  "tradingTransactions": [
    {
      "transactionId": "1111111",
      "transactionReference": "abcdefg12345678",
      "created": "2026-06-06 12:00",
      "grossValue": "100.00",
      "productCode": "1",
      "metaData": "",
      "status": "Success",
      "serialNumber": "20260611111",
      "productGroup": "1Voucher",
      "productName": "R100 1Voucher",
      "vendorName": "1Voucher",
      "transactionType": "Purchase"
    }
  ]
}

{
  "tradingTransactions": [
    {
      "transactionId": "1111111",
      "transactionReference": "abcdefg12345678",
      "created": "2026-06-06 12:00",
      "grossValue": "100.00",
      "productCode": "1",
      "metaData": "",
      "status": "Success",
      "serialNumber": "20260611111",
      "productGroup": "1Voucher",
      "productName": "R100 1Voucher",
      "vendorName": "1Voucher",
      "transactionType": "Purchase"
    }
  ]
}

{
  "tradingTransactions": [
    {
      "transactionId": "1111111",
      "transactionReference": "abcdefg12345678",
      "created": "2026-06-06 12:00",
      "grossValue": "100.00",
      "productCode": "1",
      "metaData": "",
      "status": "Success",
      "serialNumber": "20260611111",
      "productGroup": "1Voucher",
      "productName": "R100 1Voucher",
      "vendorName": "1Voucher",
      "transactionType": "Purchase"
    }
  ]
}

Front end design example

Design suggestion only. These screens illustrate one way to present the Partner Support API Transactions call.

4.3 1Voucher Status

4.3.1 Topic Overview

This topic enables corporates to retrieve the status of any 1Voucher that doesn't have to be processed through their Trading Account's specific v4 API for support and dispute resolution purposes.

For example: A customer is trying to redeem a transaction into your system, you can see if it's still active to be redeemed, cancelled or already redeemed to assist the customer.

4.3.2 Get Voucher Status

Summary

Returns the status of a voucher or serial number

One 1Voucher transaction can be searched for at a time.

Voucher status lookup rate limit: 10 calls per minute.

Endpoint Details

Item	Value
HTTP Method	POST
URL	/voucher-search/voucher-status
Production Base URL	https://api-integrations.flash.co.za/aggregation/support/1.0
Staging Base URL	https://aggregation-partner-support-api-staging.qa.flash.co.za

Request Parameters

Parameter	Type	Required	Description
AccountNumber	string	Yes	Trading account number
Reference	string	Yes	Guid reference number for caching
SerialNumber	string	Yes	Serial number

Response Fields

Field	Type	Description
Created	string	Date voucher was created
ProductGroup	string	Product group
Status	string	Current voucher status
SerialNumber	string	Serial number

Request Example

{
  "accountNumber": "1234-abcd-5678-efgh",
  "reference": "abcdefghij",
  "serialNumber": "202611111111111"
}

{
  "accountNumber": "1234-abcd-5678-efgh",
  "reference": "abcdefghij",
  "serialNumber": "202611111111111"
}

{
  "accountNumber": "1234-abcd-5678-efgh",
  "reference": "abcdefghij",
  "serialNumber": "202611111111111"
}

Response Example

{
  "created": "2026-01-01 12:00",
  "status": "Redeemed",
  "serialNumber": "202611111111111",
  "productGroup": "One Voucher"
}

{
  "created": "2026-01-01 12:00",
  "status": "Redeemed",
  "serialNumber": "202611111111111",
  "productGroup": "One Voucher"
}

{
  "created": "2026-01-01 12:00",
  "status": "Redeemed",
  "serialNumber": "202611111111111",
  "productGroup": "One Voucher"
}

Front end design example

4.4 Exclusive Voucher

4.4.1 Topic Overview

This topic enables corporates to retrieve the current details of an exclusive voucher that they own on their specific trading account. Results display all transaction types associated by the voucher for the owner to view all information.

4.4.2 Get Voucher Details

Summary

Returns the current details of an exclusive voucher.

One transaction can be searched for at a time.

Exclusive Voucher status lookup rate limit: 10 calls per minute.

Endpoint Details

Item	Value
HTTP Method	POST
URL	/voucher-search/voucher-status
Production Base URL	https://api-integrations.flash.co.za/aggregation/support/1.0
Staging Base URL	https://aggregation-partner-support-api-staging.qa.flash.co.za

Request Parameters

Parameter	Type	Required	Description
AccountNumber	string	Yes	Trading account number
Reference	string	Yes	Guid reference number for caching
SerialNumber	string	Yes	Serial number

Response Fields

Field	Type	Description
Serial	string	Voucher serial number
Status	string	Current voucher status
Currency	string	Currency type of voucher
ProductName	string	Product name
TransactionType	string	Transaction type
TransactionDate	string	Date and time of transaction [yyyy-mm-dd hh:mm]
Value	string	Value of transaction
Client	string	Client name where transaction occurred
Channel	string	Channel where the transaction occurred

Request Example

{
  "accountNumber": "1234-abcd-5678-efgh",
  "externalReference": "abcdefghij",
  "serialNumber": "20261111111111"
}

{
  "accountNumber": "1234-abcd-5678-efgh",
  "externalReference": "abcdefghij",
  "serialNumber": "20261111111111"
}

{
  "accountNumber": "1234-abcd-5678-efgh",
  "externalReference": "abcdefghij",
  "serialNumber": "20261111111111"
}

Response Example

{
  "token": {
    "serial": "20261111111111",
    "status": "Redeemed",
    "currency": "ZAR",
    "productName": "Token"
},
"transactions": [
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "Sale",
    "value": "1000",
    "channel": "Trader",
    "client": "Trader"
  },
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "FullRedemption",
    "value": "1000",
    "channel": "Aggregation",
    "client": "Flash Integrations"
  }
]

{
  "token": {
    "serial": "20261111111111",
    "status": "Redeemed",
    "currency": "ZAR",
    "productName": "Token"
},
"transactions": [
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "Sale",
    "value": "1000",
    "channel": "Trader",
    "client": "Trader"
  },
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "FullRedemption",
    "value": "1000",
    "channel": "Aggregation",
    "client": "Flash Integrations"
  }
]

{
  "token": {
    "serial": "20261111111111",
    "status": "Redeemed",
    "currency": "ZAR",
    "productName": "Token"
},
"transactions": [
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "Sale",
    "value": "1000",
    "channel": "Trader",
    "client": "Trader"
  },
  {
    "transactionDate": "2026-01-11 12:00",
    "transactionType": "FullRedemption",
    "value": "1000",
    "channel": "Aggregation",
    "client": "Flash Integrations"
  }
]

Front end design example

Design suggestion only. These screens illustrate one way to present the Partner Support API Balance call.

5. Common Patterns & Conventions

5.1 Date & Time Format

All timestamps are returned in ISO 8601 format

5.2 Numeric Values

All monetary values are returned as decimals in ZAR unless stated otherwise

6. Error Response Codes

Response Code	Message
1009	Search value cannot be empty or null
1010	Search value cannot be longer than 128 characters
1011	Product group cannot be empty or null
1102	Account not found "path": "/account/balance"
1104	No balances found for account number "path": "/api/v1/account/balance"
1401	Unable to find transaction "path": "/transaction/search-transactions"
1403	Voucher was not found: "path": "/voucher-search/owned-voucher-lookup"
1405	Invalid search type
4001	The product group is invalid "path": "/voucher-search/voucher-status"
4002	No Products found for this account

Next section:

Members & Access

Terms & Conditions

Cookie Policy

Terms & Conditions

Cookie Policy

Purpose of this Document

Purpose of this Document

1. Overview

1. Overview

1.1 What this API does

1.2 Intended Audience

2. Authentication

2. Authentication

2.1 Authentication Method

Item

Description

3. Error Handling (Standard)

3. Error Handling (Standard)

3.1 HTTP Status Codes

Status Code

Meaning

3.2 API Response Codes

Field

Description

4. API Reference – Topic Structure

4. API Reference – Topic Structure

Each Topic represents a logical support capability exposed through the Partner Support API.

4.1 Balance Status Check

4.1.1 Topic Overview

4.1.2 Get Account Balance

Endpoint Details

Item

Value

Request Parameters

Parameter

Type

Required

Description

Response Fields

Field

Type

Description

Request example

Response Example

Front end design example

4.2 Transaction Search

4.2 Transaction Search

4.2.1 Topic Overview

4.2.2 Search Transactions

Endpoint Details

Item

Value

Request Parameters

Parameter

Type

Required

Description

Response Fields

Field

Type

Description

Request Example

Response Example

Front end design example

4.3 1Voucher Status

4.3 1Voucher Status

4.3.1 Topic Overview

4.3.2 Get Voucher Status

Endpoint Details

Item

Value

Request Parameters

Parameter

Type

Required

Description

Response Fields

Field

Type

Description

Request Example

Response Example

Front end design example

4.4 Exclusive Voucher

4.4 Exclusive Voucher