Electrum Regulated Payments Events API (15.2.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

Provide event data

Request

Provides event details.

Bodyapplication/jsonrequired
apiVersionstringrequired

The version of the Electrum Regulated Payments Events API which the event format conforms to i.e. the version of this API.

classstringrequired

The class of the event.

Discriminator
identifiersobject(EventEsmIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

identifiers.​uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference. This identifier remains the same for all messages related to the same transaction.

identifiers.​endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

identifiers.​transactionIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre- agreed period.

identifiers.​matchingKeystring<= 64 characters

A unique identifier that is used to identify an EFT record. This field is computed using the fields in the EFT record.

creationDateTimestring(date-time)required

The date and time at which the event was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

actionDatestring(date)required

The date at which the transaction should take effect. The date must be formatted as defined by date-time in RFC3339

transactionInfoobject(EventEsmTransactionInfo)required
transactionInfo.​recordTypestringrequired
Enum"PAYMENT""UNPAID_INPUT""UNPAID_OUTPUT""RECALL_OUTPUT""SEC_REQUEST""SEC_RESPONSE""SEC_UNPAID_INPUT""HOMED_BACK"
transactionInfo.​paymentTypestringrequired

Enumerates the specific transaction processing event being emitted.

Enum"CREDIT""DEBIT"
transactionInfo.​directionstringrequired

Indicates the direction of the payment, from the perspective of Electrum and the Partner.

Enum"INBOUND""OUTBOUND""ON_US"
transactionInfo.​subServicestringrequired
Enum"SAME_DAY""ONE_DAY""TWO_DAY""RECALLS""SYSTEM_ERROR_CORRECTION""SYSTEM_ERROR_CORRECTION_RESPONSE"
transactionInfo.​returnTypestring

Indicates the cause of an unpaid/payment return.

Enum"DISPUTE""UNPAID""HOME_BACK""SEC_SUCCESSFUL""RECALL_RESULT"
stateobject(EventEsmState)required
state.​transactionStatestringrequired

The state of the given transaction.

Enum"RECEIVE_PENDING""RECEIVED""RECEIVE_ERROR""CANCELLED""SEND_PENDING""SENT""SEND_ERROR""ON_HOLD"
state.​financialTransactionStatestringrequired

The state of the financial transaction for the given transaction.

Enum"IN_PROGRESS""ACTIONED""UNPAID""ERROR""UNMATCHED"
eftDataRecordobject(EventEsmPayload)
curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-events/events \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "TRANSACTION_STATE_CREDIT_AUTH_RECEIVED",
    "apiVersion": "0.27.0",
    "class": "TRANSACTION_STATE",
    "type": "CREDIT_AUTH_RECEIVED",
    "stageVersion": 1,
    "tranInfo": {
      "tranUetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
      "direction": "INBOUND",
      "paymentScheme": "ZA_RTC",
      "service": "RTC_INBOUND"
    },
    "messageInfo": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "payload": {
      "schema": "CreditTransfer",
      "messageIdentifiers": {
        "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
        "creationDateTime": "2022-05-04T03:02:01Z"
      },
      "paymentScheme": {
        "schema": "ZA_RTC",
        "schemeData": {
          "userReference": "Ab1 xxxxxxxxxxxxxxxx",
          "originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
          "businessReference": "11Ab1xxxxx"
        }
      },
      "transactionIdentifiers": {
        "endToEndIdentification": "6249118655591098",
        "transactionIdentification": "RRN000000001",
        "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
      },
      "amounts": {
        "bankSettlementAmount": {
          "value": 1,
          "currency": "ZAR"
        },
        "instructedAmount": {
          "value": 1,
          "currency": "ZAR"
        }
      },
      "paymentTypeInformation": {
        "localInstrument": {
          "schema": "CODE",
          "value": "BTR"
        }
      },
      "creditor": {
        "address": {
          "addressType": "ADDR",
          "department": "Department of Mysteries",
          "streetName": "Street of Mysteries",
          "buildingNumber": 42,
          "buildingName": "Mysterious Building",
          "floor": 42,
          "postBox": 1024,
          "postCode": 4242,
          "townName": "Mysty Town",
          "townLocationName": "Mysty Location",
          "districtName": "Mysty District",
          "countrySubDivision": "Mysterious Cape",
          "country": "ZA",
          "addressLine": [
            "16A",
            "New market street",
            "Foreshore",
            "Cape Town",
            "ZA",
            8001
          ]
        },
        "contactDetails": {
          "phoneNumber": "+27-0214620000",
          "mobileNumber": "+27-08230000000",
          "emailAddress": "bob@grey.com"
        },
        "countryOfResidence": "ZA",
        "identification": {
          "schema": "PERSON",
          "identifiers": [
            {
              "identification": 90001236549870,
              "issuer": "Dept of Home Affairs",
              "scheme": {
                "schema": "CODE",
                "value": "NIDN"
              }
            }
          ]
        }
      },
      "creditorAccount": {
        "identification": {
          "schema": "GENERIC",
          "scheme": {
            "schema": "PROPRIETARY",
            "value": "AProprietaryCode123"
          },
          "issuer": "Blue Bank",
          "value": "abcdef987654"
        },
        "type": {
          "schema": "CODE",
          "value": "CACC"
        },
        "currency": "ZAR"
      },
      "creditorAgent": {
        "bicfi": "BLUEZAJ0",
        "memberId": "BlueBankId",
        "name": "Blue Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "debtor": {
        "address": {
          "addressType": "ADDR",
          "department": "Department of Mysteries",
          "streetName": "Street of Mysteries",
          "buildingNumber": 42,
          "buildingName": "Mysterious Building",
          "floor": 42,
          "postBox": 1024,
          "postCode": 4242,
          "townName": "Mysty Town",
          "townLocationName": "Mysty Location",
          "districtName": "Mysty District",
          "countrySubDivision": "Mysterious Cape",
          "country": "ZA",
          "addressLine": [
            "16A",
            "New market street",
            "Foreshore",
            "Cape Town",
            "ZA",
            8001
          ]
        },
        "contactDetails": {
          "phoneNumber": "+27-0214620000",
          "mobileNumber": "+27-08230000000",
          "emailAddress": "bob@grey.com"
        },
        "countryOfResidence": "ZA",
        "identification": {
          "schema": "PERSON",
          "identifiers": [
            {
              "identification": 90001236549870,
              "issuer": "Dept of Home Affairs",
              "scheme": {
                "schema": "CODE",
                "value": "NIDN"
              }
            }
          ]
        }
      },
      "debtorAccount": {
        "identification": {
          "schema": "GENERIC",
          "scheme": {
            "schema": "PROPRIETARY",
            "value": "AProprietaryCode123"
          },
          "issuer": "Grey Bank",
          "value": "abcdef987654"
        },
        "type": {
          "schema": "CODE",
          "value": "CACC"
        },
        "currency": "ZAR"
      },
      "debtorAgent": {
        "bicfi": "GREYZAJ0",
        "memberId": "GreyBankId",
        "name": "Grey Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructingAgent": {
        "bicfi": "GREYZAJ0",
        "memberId": "GreyBankId",
        "name": "Grey Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructedAgent": {
        "bicfi": "GREYZAJ0",
        "memberId": "GreyBankId",
        "name": "Grey Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructionForCreditorAgent": [
        {
          "code": "TELA",
          "information": "Please email example@example.com"
        }
      ],
      "intermediaryAgents": [
        {
          "bicfi": "GREYZAJ0",
          "memberId": "GreyBankId",
          "name": "Grey Bank Inc",
          "branch": {
            "identification": 210514,
            "name": "ABC Plettenberg Bay",
            "address": {
              "addressType": "ADDR",
              "department": "Department of Mysteries",
              "streetName": "Street of Mysteries",
              "buildingNumber": 42,
              "buildingName": "Mysterious Building",
              "floor": 42,
              "postBox": 1024,
              "postCode": 4242,
              "townName": "Mysty Town",
              "townLocationName": "Mysty Location",
              "districtName": "Mysty District",
              "countrySubDivision": "Mysterious Cape",
              "country": "ZA",
              "addressLine": [
                "16A",
                "New market street",
                "Foreshore",
                "Cape Town",
                "ZA",
                8001
              ]
            }
          }
        }
      ],
      "previousInstructingAgents": [
        {
          "bicfi": "GREYZAJ0",
          "memberId": "GreyBankId",
          "name": "Grey Bank Inc",
          "branch": {
            "identification": 210514,
            "name": "ABC Plettenberg Bay",
            "address": {
              "addressType": "ADDR",
              "department": "Department of Mysteries",
              "streetName": "Street of Mysteries",
              "buildingNumber": 42,
              "buildingName": "Mysterious Building",
              "floor": 42,
              "postBox": 1024,
              "postCode": 4242,
              "townName": "Mysty Town",
              "townLocationName": "Mysty Location",
              "districtName": "Mysty District",
              "countrySubDivision": "Mysterious Cape",
              "country": "ZA",
              "addressLine": [
                "16A",
                "New market street",
                "Foreshore",
                "Cape Town",
                "ZA",
                8001
              ]
            }
          }
        }
      ],
      "purpose": {
        "schema": "CODE",
        "value": "BKDF"
      },
      "remittanceInformation": {
        "unstructured": [
          "some",
          "unstructured",
          "information"
        ],
        "structured": [
          {
            "referredDocuments": [
              {
                "type": {
                  "issuer": "GreyBank123456",
                  "schema": "CODE",
                  "value": "CINV"
                },
                "documentIdentifier": "A0123456789"
              }
            ],
            "referredDocumentAmount": {
              "duePayableAmount": {
                "value": 1,
                "currency": "ZAR"
              },
              "remittedAmount": {
                "value": 1,
                "currency": "ZAR"
              }
            },
            "creditorReference": {
              "type": {
                "issuer": "GreyBank1234",
                "schema": "CODE",
                "value": "RADM"
              },
              "reference": "ABC123XYZ999"
            },
            "additionalRemittanceInformation": [
              "Some",
              "Additional",
              "Information"
            ]
          }
        ]
      },
      "tax": {
        "totalAmount": {
          "value": 1,
          "currency": "ZAR"
        }
      }
    }
  }'

Responses

Schema

Copyright 2025 | Electrum Payments (Pty) Ltd