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

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

OK. RFC9110 - 200

Bodyapplication/json

statesArray of stringsrequired

Response

application/json

{
  "states": [
    "string"
  ]
}