Electrum Regulated Payments Events API (17.1.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

Download OpenAPI description
elpapi-events.json
elpapi-events.yaml
Overview
URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Languages
Servers
Mock server

https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-events/

Payments API sandbox

https://example.com/path/payments/events-api/v1/

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

Operations

Schema

PersonIdentificationCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired
  • ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
  • CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
  • CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
  • DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
  • EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
  • NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
  • SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
  • TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
  • TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
  • POID: PersonOtherIdentification. Other identification of the person.
Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"
{
  "schema": "string",
  "value": "ARNU"
}

PersonIdentifierScheme

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
valuestringrequired
  • ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
  • CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
  • CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
  • DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
  • EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
  • NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
  • SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
  • TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
  • TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
  • POID: PersonOtherIdentification. Other identification of the person.
Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"
{
  "schema": "CODE",
  "value": "ARNU"
}

PersonIdentifier

identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

issuerstring<= 35 characters

The entity that assigns the identification

schemeobject(PersonIdentifierScheme)
{
  "identification": "string",
  "issuer": "string",
  "scheme": {
    "schema": "string",
    "value": "ARNU"
  }
}
Copyright 2025 | Electrum Payments (Pty) Ltd