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.

Overview
Languages
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

Return the set of states for an initiated transaction

Request

This operation is a synchronous request.

Instructs Electrum to collect and return the set of states for an initiated transaction. The response of this operation is a list of these states.

Path
uetrstring(uuid)required

The UETR/UUID for the transaction being queried

curl -i -X GET \
  'https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/bpp-testing-platform-api/tests/{uetr}'

Responses

Bodyapplication/json
statesArray of stringsrequired
Response
application/json
{ "states": [ "string" ] }

Initiates a test transaction from the EPC Testing Platform

Request

This operation is a synchronous request.

Instructs Electrum to initiate a test transaction from the EPC Testing Platform. The response of this operation is the UETR/UUID for the initiated transaction

Bodyapplication/jsonrequired
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

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/bpp-testing-platform-api/tests \
  -H 'Content-Type: application/json' \
  -d '{
    "testId": "string",
    "initiationDetails": {
      "domain": "string",
      "proxy": "string",
      "proxyType": "MBNO",
      "amount": 0.1,
      "creditorReference": "string"
    }
  }'

Responses

Bodyapplication/json
uetrstring(uuid)

The UETR/UUID for the newly initiated transaction

Response
application/json
{ "uetr": "00168b15-e953-4990-a0c1-a37ad64c1587" }

query

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

Operations

Schema