Electrum EPC Testing Platform API (1.0.0)

The Electrum EPC Testing Platform API is an API which Corporate Clients can use to interact with the Electrum EPC Testing Platform. The API allows Corporate Clients to initiate test transactions and to query test result data.

Download OpenAPI description

bpp-testing-platform-api.json

bpp-testing-platform-api.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/bpp-testing-platform-api/

Electrum EPC Testing Platform API

https://sandbox.electrum.dev/epc/testing/platform/api/v1/

initiation

Operations that participate in initiating a test transaction through the Electrum EPC Testing Platform.

Operations

query

Operations that participate in querying the status of an existing test transaction

Operations

Schema

QueryResponse

statesArray of stringsrequired

{
  "states": [
    "string"
  ]
}

InitiationRequest

testIdstringrequired

initiationDetailsobject(InitiationDetails)required

initiationDetails.domainstringrequired

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

which is essentially a type of namespace.

This value should correspond to the the Corporate Client who is initiating the request's domain

initiationDetails.proxystringrequired

The value for which the proxy resolution will be performed

initiationDetails.proxyTypestring

The type of proxy, such as MBNO (mobile number) or CUST (custom). Initiations will default to MBNO if this is not set.

Enum"MBNO""CUST"

initiationDetails.amountnumber(double)>= 0

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

initiationDetails.creditorReferencestring

The reference for the creditor

{
  "testId": "string",
  "initiationDetails": {
    "domain": "string",
    "proxy": "string",
    "proxyType": "MBNO",
    "amount": 0.1,
    "creditorReference": "string"
  }
}

InitiationDetails

domainstringrequired

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

which is essentially a type of namespace.

This value should correspond to the the Corporate Client who is initiating the request's domain

proxystringrequired

The value for which the proxy resolution will be performed

proxyTypestring

The type of proxy, such as MBNO (mobile number) or CUST (custom). Initiations will default to MBNO if this is not set.

Enum"MBNO""CUST"

amountnumber(double)>= 0

creditorReferencestring

The reference for the creditor

{
  "domain": "string",
  "proxy": "string",
  "proxyType": "MBNO",
  "amount": 0.1,
  "creditorReference": "string"
}

InitiationResponse

uetrstring(uuid)

The UETR/UUID for the newly initiated transaction

{
  "uetr": "00168b15-e953-4990-a0c1-a37ad64c1587"
}

ErrorResponse

reasonstring

The reason why the test initiation failed

descriptionstring

A full description explaining the failure in detail

{
  "reason": "string",
  "description": "string"
}