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

SecUnpaidInputRecord

effectiveActionDatestring(date)required

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

filler1integer
newSequenceNumberintegerrequired
originalAccountTypeintegerrequired
originalActionDatestring(date)required

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

originalAmountinteger
originalEntryClassintegerrequired
originalHomingAccountNamestringrequired
originalHomingInstitutioninteger
originalSequenceNumberintegerrequired
originalTaxCodeinteger
originalUserReferencestringrequired
reasonCodestring(ReasonCode)required
Enum"NOT_PROVIDED_FOR""DEBITS_OR_CREDITS_NOT_ALLOWED_TO_ACCOUNT""PAYMENT_STOPPED_BY_ACCOUNT_HOLDER""ACCOUNT_FROZEN""ACCOUNT_IN_SEQUESTRATION""ACCOUNT_IN_LIQUIDATION""ACCOUNT_CLOSED""ACCOUNT_TRANSFERRED_WITHIN_BANKING_GROUP""ACCOUNT_TRANSFERRED_TO_OTHER_BANKING_GROUP""ACCOUNT_HOLDER_DECEASED"
recordIdentifierstring(RecordIdentifier)required
Enum"CREDIT""STOP_ORDER_CREDIT""CONSOLIDATED_UNPAID_CREDIT""UNPAID_CREDIT""CREDIT_RECALL""CREDIT_SEC_REQUEST""CREDIT_SEC_RESPONSE""DEBIT""CONSOLIDATED_UNPAID_DEBIT""UNPAID_DEBIT"
bankSuspenseAccountstringrequired
bankSuspenseBranchstringrequired
filler2string
originalBranchCodestringrequired
originalHomingAccountstringrequired
originalHomingBranchstringrequired
originalUserAccountstringrequired
originalUserCodestringrequired
nonStandardHomingAccountstring
schemastringrequired
Value"SecUnpaidInputRecord"
{
  "effectiveActionDate": "2019-08-24",
  "filler1": 0,
  "newSequenceNumber": 0,
  "originalAccountType": 0,
  "originalActionDate": "2019-08-24",
  "originalAmount": 0,
  "originalEntryClass": 0,
  "originalHomingAccountName": "string",
  "originalHomingInstitution": 0,
  "originalSequenceNumber": 0,
  "originalTaxCode": 0,
  "originalUserReference": "string",
  "reasonCode": "NOT_PROVIDED_FOR",
  "recordIdentifier": "CREDIT",
  "bankSuspenseAccount": "string",
  "bankSuspenseBranch": "string",
  "filler2": "string",
  "originalBranchCode": "string",
  "originalHomingAccount": "string",
  "originalHomingBranch": "string",
  "originalUserAccount": "string",
  "originalUserCode": "string",
  "nonStandardHomingAccount": "string",
  "schema": "SecUnpaidInputRecord"
}

UnpaidInputRecord

effectiveActionDatestring(date)required

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

filler1integer
newSequenceNumberintegerrequired
originalAccountTypeintegerrequired
originalActionDatestring(date)required

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

originalAmountinteger
originalEntryClassintegerrequired
originalHomingAccountNamestringrequired
originalHomingInstitutioninteger
originalSequenceNumberintegerrequired
originalTaxCodeinteger
originalUserReferencestringrequired
reasonCodestring(ReasonCode)required
Enum"NOT_PROVIDED_FOR""DEBITS_OR_CREDITS_NOT_ALLOWED_TO_ACCOUNT""PAYMENT_STOPPED_BY_ACCOUNT_HOLDER""ACCOUNT_FROZEN""ACCOUNT_IN_SEQUESTRATION""ACCOUNT_IN_LIQUIDATION""ACCOUNT_CLOSED""ACCOUNT_TRANSFERRED_WITHIN_BANKING_GROUP""ACCOUNT_TRANSFERRED_TO_OTHER_BANKING_GROUP""ACCOUNT_HOLDER_DECEASED"
recordIdentifierstring(RecordIdentifier)required
Enum"CREDIT""STOP_ORDER_CREDIT""CONSOLIDATED_UNPAID_CREDIT""UNPAID_CREDIT""CREDIT_RECALL""CREDIT_SEC_REQUEST""CREDIT_SEC_RESPONSE""DEBIT""CONSOLIDATED_UNPAID_DEBIT""UNPAID_DEBIT"
bankSuspenseAccountstringrequired
bankSuspenseBranchstringrequired
filler2string
originalBranchCodestringrequired
originalHomingAccountstringrequired
originalHomingBranchstringrequired
originalUserAccountstringrequired
originalUserCodestringrequired
newAccountTypeinteger
newHomingAccountstring
newHomingBranchstring
schemastringrequired
Value"UnpaidInputRecord"
{
  "effectiveActionDate": "2019-08-24",
  "filler1": 0,
  "newSequenceNumber": 0,
  "originalAccountType": 0,
  "originalActionDate": "2019-08-24",
  "originalAmount": 0,
  "originalEntryClass": 0,
  "originalHomingAccountName": "string",
  "originalHomingInstitution": 0,
  "originalSequenceNumber": 0,
  "originalTaxCode": 0,
  "originalUserReference": "string",
  "reasonCode": "NOT_PROVIDED_FOR",
  "recordIdentifier": "CREDIT",
  "bankSuspenseAccount": "string",
  "bankSuspenseBranch": "string",
  "filler2": "string",
  "originalBranchCode": "string",
  "originalHomingAccount": "string",
  "originalHomingBranch": "string",
  "originalUserAccount": "string",
  "originalUserCode": "string",
  "newAccountType": 0,
  "newHomingAccount": "string",
  "newHomingBranch": "string",
  "schema": "UnpaidInputRecord"
}

UnpaidOutputRecord

effectiveActionDatestring(date)required

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

filler1integer
newSequenceNumberintegerrequired
originalAccountTypeintegerrequired
originalActionDatestring(date)required

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

originalAmountinteger
originalEntryClassintegerrequired
originalHomingAccountNamestringrequired
originalHomingInstitutioninteger
originalSequenceNumberintegerrequired
originalTaxCodeinteger
originalUserReferencestringrequired
reasonCodestring(ReasonCode)required
Enum"NOT_PROVIDED_FOR""DEBITS_OR_CREDITS_NOT_ALLOWED_TO_ACCOUNT""PAYMENT_STOPPED_BY_ACCOUNT_HOLDER""ACCOUNT_FROZEN""ACCOUNT_IN_SEQUESTRATION""ACCOUNT_IN_LIQUIDATION""ACCOUNT_CLOSED""ACCOUNT_TRANSFERRED_WITHIN_BANKING_GROUP""ACCOUNT_TRANSFERRED_TO_OTHER_BANKING_GROUP""ACCOUNT_HOLDER_DECEASED"
recordIdentifierstring(RecordIdentifier)required
Enum"CREDIT""STOP_ORDER_CREDIT""CONSOLIDATED_UNPAID_CREDIT""UNPAID_CREDIT""CREDIT_RECALL""CREDIT_SEC_REQUEST""CREDIT_SEC_RESPONSE""DEBIT""CONSOLIDATED_UNPAID_DEBIT""UNPAID_DEBIT"
filler2string
filler3string
filler4string
filler5string
newAccountstring
newAccountTypestring
newBranchstring
originalHomingAccountstringrequired
originalHomingBranchstringrequired
originalUserAccountstringrequired
originalUserBranchstringrequired
schemastringrequired
Value"UnpaidOutputRecord"
userCodestringrequired
{
  "effectiveActionDate": "2019-08-24",
  "filler1": 0,
  "newSequenceNumber": 0,
  "originalAccountType": 0,
  "originalActionDate": "2019-08-24",
  "originalAmount": 0,
  "originalEntryClass": 0,
  "originalHomingAccountName": "string",
  "originalHomingInstitution": 0,
  "originalSequenceNumber": 0,
  "originalTaxCode": 0,
  "originalUserReference": "string",
  "reasonCode": "NOT_PROVIDED_FOR",
  "recordIdentifier": "CREDIT",
  "filler2": "string",
  "filler3": "string",
  "filler4": "string",
  "filler5": "string",
  "newAccount": "string",
  "newAccountType": "string",
  "newBranch": "string",
  "originalHomingAccount": "string",
  "originalHomingBranch": "string",
  "originalUserAccount": "string",
  "originalUserBranch": "string",
  "schema": "UnpaidOutputRecord",
  "userCode": "string"
}
Copyright 2025 | Electrum Payments (Pty) Ltd