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

StatusReasonInfo

Provides detailed information on a status reason.

additionalInformationstring

A human friendly description of the status reason including any further details if applicable.

reasonobject(StatusReasonType)required
reason.​schemastringrequired

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

Discriminator
reason.​valuestringrequired
  • ACCC : AcceptedSettlementCompletedCreditorAccount
  • ACCP : AcceptedCustomerProfile
  • ACSC : AcceptedSettlementCompletedDebtorAccount
  • ACTC : AcceptedTechnicalValidation
  • ACWP : AcceptedWithoutPosting
  • ACSP : AcceptedSettlementInProcess
  • ACWC : AcceptedWithChange
  • AB01 : AbortedClearingTimeout
  • AB02 : AbortedClearingFatalError
  • AB03 : AbortedSettlementTimeout
  • AB04 : AbortedSettlementFatalError
  • AB05 : TimeoutCreditorAgent
  • AB06 : TimeoutInstructedAgent
  • AB07 : OfflineAgent
  • AB08 : OfflineCreditorAgent
  • AB09 : ErrorCreditorAgent
  • AB10 : ErrorInstructedAgent
  • AB11 : TimeoutDebtorAgent
  • AC01 : IncorrectAccountNumber
  • AC02 : InvalidDebtorAccountNumber
  • AC03 : InvalidCreditorAccountNumber
  • AC04 : ClosedAccountNumber
  • AC05 : ClosedDebtorAccountNumber
  • AC06 : BlockedAccount
  • AC07 : ClosedCreditorAccountNumber
  • AC08 : InvalidBranchCode
  • AC09 : InvalidAccountCurrency
  • AC10 : InvalidDebtorAccountCurrency
  • AC11 : InvalidCreditorAccountCurrency
  • AC12 : InvalidAccountType
  • AC13 : InvalidDebtorAccountType
  • AC14 : InvalidCreditorAccountType
  • AC15 : AccountDetailsChanged
  • AC16 : CardNumberInvalid
  • AC17 : AccountInLiquidation
  • AEXR : AlreadyExpiredRTP
  • AG01 : TransactionForbidden
  • AG02 : InvalidBankOperationCode
  • AG03 : TransactionNotSupported
  • AG04 : InvalidAgentCountry
  • AG05 : InvalidDebtorAgentCountry
  • AG06 : InvalidCreditorAgentCountry
  • AG07 : UnsuccessfulDirectDebit
  • AG08 : InvalidAccessRights
  • AG09 : PaymentNotReceived
  • AG10 : AgentSuspended
  • AG11 : CreditorAgentSuspended
  • AG12 : NotAllowedBookTransfer
  • AG13 : ForbiddenReturnPayment
  • AGNT : IncorrectAgent
  • ALAC : AlreadyAcceptedRTP
  • AM01 : ZeroAmount
  • AM02 : NotAllowedAmount
  • AM03 : NotAllowedCurrency
  • AM04 : InsufficientFunds
  • AM05 : Duplication
  • AM06 : TooLowAmount
  • AM07 : BlockedAmount
  • AM09 : WrongAmount
  • AM10 : InvalidControlSum
  • AM11 : InvalidTransactionCurrency
  • AM12 : InvalidAmount
  • AM13 : AmountExceedsClearingSystemLimit
  • AM14 : AmountExceedsAgreedLimit
  • AM15 : AmountBelowClearingSystemMinimum
  • AM16 : InvalidGroupControlSum
  • AM17 : InvalidPaymentInfoControlSum
  • AM18 : InvalidNumberOfTransactions
  • AM19 : InvalidGroupNumberOfTransactions
  • AM20 : InvalidPaymentInfoNumberOfTransactions
  • AM21 : LimitExceeded
  • AM22 : ZeroAmountNotApplied
  • AM23 : AmountExceedsSettlementLimit
  • APAR : AlreadyPaidRTP
  • ARDT : AlreadyReturnedTransaction
  • ARFR : AlreadyRefusedRTP
  • ARJR : AlreadyRejectedRTP
  • ATNS : AttachmentsNotSupported
  • BE01 : InconsistentWithEndCustomer
  • BE04 : MissingCreditorAddress
  • BE05 : UnrecognisedInitiatingParty
  • BE06 : UnknownEndCustomer
  • BE07 : MissingDebtorAddress
  • BE08 : MissingDebtorName
  • BE09 : InvalidCountry
  • BE10 : InvalidDebtorCountry
  • BE11 : InvalidCreditorCountry
  • BE12 : InvalidCountryOfResidence
  • BE13 : InvalidDebtorCountryOfResidence
  • BE14 : InvalidCreditorCountryOfResidence
  • BE15 : InvalidIdentificationCode
  • BE16 : InvalidDebtorIdentificationCode
  • BE17 : InvalidCreditorIdentificationCode
  • BE18 : InvalidContactDetails
  • BE19 : InvalidChargeBearerCode
  • BE20 : InvalidNameLength
  • BE21 : MissingName
  • BE22 : MissingCreditorName
  • BE23 : AccountProxyInvalid
  • CERI : CheckERI
  • CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
  • CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
  • CH07 : ElementIsNotToBeUsedAtB-andC-Level
  • CH09 : MandateChangesNotAllowed
  • CH10 : InformationOnMandateChangesMissing
  • CH11 : CreditorIdentifierIncorrect
  • CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
  • CH13 : OriginalDebtorAccountIsNotToBeUsed
  • CH14 : OriginalDebtorAgentIsNotToBeUsed
  • CH15 : ElementContentIncludesMoreThan140Characters
  • CH16 : ElementContentFormallyIncorrect
  • CH17 : ElementNotAdmitted
  • CH19 : ValuesWillBeSetToNextTARGETday
  • CH20 : DecimalPointsNotCompatibleWithCurrency
  • CH21 : RequiredCompulsoryElementMissing
  • CH22 : COREandB2BwithinOnemessage
  • CHQC : ChequeSettledOnCreditorAccount
  • CN01 : AuthorisationCancelled
  • CNOR : CreditorBankIsNotRegistered
  • CURR : IncorrectCurrency
  • CUST : RequestedByCustomer
  • DNOR : DebtorBankIsNotRegistered
  • DS01 : ElectronicSignaturesCorrect
  • DS02 : OrderCancelled
  • DS03 : OrderNotCancelled
  • DS04 : OrderRejected
  • DS05 : OrderForwardedForPostprocessing
  • DS06 : TransferOrder
  • DS07 : ProcessingOK
  • DS08 : DecompressionError
  • DS09 : DecryptionError
  • DS0A : DataSignRequested
  • DS0B : UnknownDataSignFormat
  • DS0C : SignerCertificateRevoked
  • DS0D : SignerCertificateNotValid
  • DS0E : IncorrectSignerCertificate
  • DS0F : SignerCertificationAuthoritySignerNotValid
  • DS0G : NotAllowedPayment
  • DS0H : NotAllowedAccount
  • DS0K : NotAllowedNumberOfTransaction
  • DS10 : Signer1CertificateRevoked
  • DS11 : Signer1CertificateNotValid
  • DS12 : IncorrectSigner1Certificate
  • DS13 : SignerCertificationAuthoritySigner1NotValid
  • DS14 : UserDoesNotExist
  • DS15 : IdenticalSignatureFound
  • DS16 : PublicKeyVersionIncorrect
  • DS17 : DifferentOrderDataInSignatures
  • DS18 : RepeatOrder
  • DS19 : ElectronicSignatureRightsInsufficient
  • DS20 : Signer2CertificateRevoked
  • DS21 : Signer2CertificateNotValid
  • DS22 : IncorrectSigner2Certificate
  • DS23 : SignerCertificationAuthoritySigner2NotValid
  • DS24 : WaitingTimeExpired
  • DS25 : OrderFileDeleted
  • DS26 : UserSignedMultipleTimes
  • DS27 : UserNotYetActivated
  • DT01 : InvalidDate
  • DT02 : InvalidCreationDate
  • DT03 : InvalidNonProcessingDate
  • DT04 : FutureDateNotSupported
  • DT05 : InvalidCutOffDate
  • DT06 : ExecutionDateChanged
  • DU01 : DuplicateMessageID
  • DU02 : DuplicatePaymentInformationID
  • DU03 : DuplicateTransaction
  • DU04 : DuplicateEndToEndID
  • DU05 : DuplicateInstructionID
  • DUPL : DuplicatePayment
  • ED01 : CorrespondentBankNotPossible
  • ED03 : BalanceInfoRequest
  • ED05 : SettlementFailed
  • ED06 : SettlementSystemNotAvailable
  • EDTL : ExpiryDateTooLong
  • EDTR : ExpiryDateTimeReached
  • ERIN : ERIOptionNotSupported
  • FF01 : InvalidFileFormat
  • FF02 : SyntaxError
  • FF03 : InvalidPaymentTypeInformation
  • FF04 : InvalidServiceLevelCode
  • FF05 : InvalidLocalInstrumentCode
  • FF06 : InvalidCategoryPurposeCode
  • FF07 : InvalidPurpose
  • FF08 : InvalidEndToEndId
  • FF09 : InvalidChequeNumber
  • FF10 : BankSystemProcessingError
  • FF11 : ClearingRequestAborted
  • FF12 : OriginalTransactionNotEligibleForRequestedReturn
  • FF13 : RequestForCancellationNotFound
  • FOCR : FollowingCancellationRequest
  • FR01 : Fraud
  • FRAD : FraudulentOrigin
  • G000 : PaymentTransferredAndTracked
  • G001 : PaymentTransferredAndNotTracked
  • G002 : CreditDebitNotConfirmed
  • G003 : CreditPendingDocuments
  • G004 : CreditPendingFunds
  • G005 : DeliveredWithServiceLevel
  • G006 : DeliveredWithoutServiceLevel
  • ID01 : CorrespondingOriginalFileStillNotSent
  • IEDT : IncorrectExpiryDateTime
  • IRNR : InitialRTPNeverReceived
  • MD01 : NoMandate
  • MD02 : MissingMandatoryInformationInMandate
  • MD05 : CollectionNotDue
  • MD06 : RefundRequestByEndCustomer
  • MD07 : EndCustomerDeceased
  • MS02 : NotSpecifiedReasonCustomerGenerated
  • MS03 : NotSpecifiedReasonAgentGenerated
  • NARR : Narrative
  • NERI : NoERI
  • NOAR : NonAgreedRTP
  • NOAS : NoAnswerFromCustomer
  • NOCM : NotCompliantGeneric
  • NOOR : NoOriginalTransactionReceived
  • NOPG : NoPaymentGuarantee
  • NRCH : PayerOrPayerRTPSPNotReachable
  • PART : PartiallyAccepted
  • PINS : TypeOfPaymentInstrumentNotSupported
  • RC01 : BankIdentifierIncorrect
  • RC02 : InvalidBankIdentifier
  • RC03 : InvalidDebtorBankIdentifier
  • RC04 : InvalidCreditorBankIdentifier
  • RC05 : InvalidBICIdentifier
  • RC06 : InvalidDebtorBICIdentifier
  • RC07 : InvalidCreditorBICIdentifier
  • RC08 : InvalidClearingSystemMemberIdentifier
  • RC09 : InvalidDebtorClearingSystemMemberIdentifier
  • RC10 : InvalidCreditorClearingSystemMemberIdentifier
  • RC11 : InvalidIntermediaryAgent
  • RC12 : MissingCreditorSchemeId
  • RCON : RMessageConflict
  • RECI : ReceiverCustomerInformation
  • REPR : RTPReceivedCanBeProcessed
  • RF01 : NotUniqueTransactionReference
  • RR01 : MissingDebtorAccountOrIdentification
  • RR02 : MissingDebtorNameOrAddress
  • RR03 : MissingCreditorNameOrAddress
  • RR04 : RegulatoryReason
  • RR05 : RegulatoryInformationInvalid
  • RR06 : TaxInformationInvalid
  • RR07 : RemittanceInformationInvalid
  • RR08 : RemittanceInformationTruncated
  • RR09 : InvalidStructuredCreditorReference
  • RR10 : InvalidCharacterSet
  • RR11 : InvalidDebtorAgentServiceID
  • RR12 : InvalidPartyID
  • RTNS : RTPNotSupportedForDebtor
  • RUTA : ReturnUponUnableToApply
  • S000 : ValidRequestForCancellationAcknowledged
  • S001 : UETRFlaggedForCancellation
  • S002 : NetworkStopOfUETR
  • S003 : RequestForCancellationForwarded
  • S004 : RequestForCancellationDeliveryAcknowledgement
  • SL01 : SpecificServiceOfferedByDebtorAgent
  • SL02 : SpecificServiceOfferedByCreditorAgent
  • SL03 : ServiceofClearingSystem
  • SL11 : CreditorNotOnWhitelistOfDebtor
  • SL12 : CreditorOnBlacklistOfDebtor
  • SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
  • SL14 : MaximumDirectDebitTransactionAmountExceeded
  • SP01 : PaymentStopped
  • SP02 : PreviouslyStopped
  • SPII : RTPServiceProviderIdentifierIncorrect
  • TA01 : TransmissionAborted
  • TD01 : NoDataAvailable
  • TD02 : FileNonReadable
  • TD03 : IncorrectFileStructure
  • TK01 : TokenInvalid
  • TK02 : SenderTokenNotFound
  • TK03 : ReceiverTokenNotFound
  • TK09 : TokenMissing
  • TKCM : TokenCounterpartyMismatch
  • TKSG : TokenSingleUse
  • TKSP : TokenSuspended
  • TKVE : TokenValueLimitExceeded
  • TKXP : TokenExpired
  • TM01 : InvalidCutOffTime
  • TS01 : TransmissionSuccessful
  • TS04 : TransferToSignByHand
  • UCRD : UnknownCreditor
  • UPAY : UnduePayment
Enum"ACCC""ACCP""ACSC""ACTC""ACWP""ACSP""ACWC""AB01""AB02""AB03"
{
  "additionalInformation": "string",
  "reason": {
    "schema": "string",
    "value": "ACCC"
  }
}

Status

outcomestringrequired
  • APPROVED: The instruction has been approved.
  • CANCELLED: The instruction has been cancelled.
  • PENDING: The instruction is pending.
  • REJECTED: The instruction has been rejected.
Enum"APPROVED""CANCELLED""PENDING""REJECTED"
reasonInfoArray of objects(StatusReasonInfo)non-empty

A list of StatusReasonInfo values providing detailed reason information for the outcome.

{
  "outcome": "APPROVED",
  "reasonInfo": [
    { … }
  ]
}

AccountVerificationResponse

A model containing the foundational elements shared across messages relating to transactions.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.​creationDateTimestring(date-time)required

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

messageIdentifiers.​messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

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

transactionIdentifiers.​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. Note: this is distinct from the UETR.

transactionIdentifiers.​instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.​transactionIdentificationstring<= 35 characters

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.

transactionIdentifiers.​uetrstring(UUID)required

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

assigneeobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

assignee.​addressobject(PostalAddress)
assignee.​contactDetailsobject(ContactDetails)
assignee.​countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

assignee.​identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

assignee.​knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

assignee.​legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

assignerobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

assigner.​addressobject(PostalAddress)
assigner.​contactDetailsobject(ContactDetails)
assigner.​countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

assigner.​identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

assigner.​knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

assigner.​legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creatorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

firstAgentobject(InstitutionIdentification)
originalAssignmentobject(Assignment)
originalMessageIdentifiersobject(MessageIdentifiers)

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalVerificationobject(Verification)
reportobject(VerificationReport)
schemastringrequired
Value"AccountVerificationResponse"
statusobject(Status)
{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "assignee": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "assigner": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "firstAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "originalAssignment": {
    "assignee": { … },
    "assigner": { … },
    "creator": { … },
    "firstAgent": { … }
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "originalVerification": {
    "account": { … },
    "agent": { … },
    "identification": "string",
    "party": { … },
    "schemeVerificationData": { … }
  },
  "report": {
    "originalIdentification": "string",
    "outcome": { … },
    "schemeVerificationReportData": { … },
    "updatedPartyAndAccount": { … }
  },
  "schema": "AccountVerificationResponse",
  "status": {
    "outcome": "APPROVED",
    "reasonInfo": [ … ]
  }
}
Copyright 2025 | Electrum Payments (Pty) Ltd