Electrum Regulated Payments Events API (26.1.1)

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

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

InvestigationStatusDuplicateOf

Indicates a duplicated case

duplicateOfobject(Case6)required

duplicateOf.creatorany(PartyInstitutionChoice)

duplicateOf.identificationstring<= 35 characters

duplicateOf.reopenCaseIndicationboolean

Indicates whether or not the case was previously closed and is now re-opened

statusTypestringrequired

Value"DUPLICATE_OF"

{
  "duplicateOf": {
    "creator": { … },
    "identification": "string",
    "reopenCaseIndication": true
  },
  "statusType": "DUPLICATE_OF"
}

ExternalPaymentModificationRejectionCode

schemastring

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

valuestring

UM01 UnableToModifyRelatedReference - Related transaction reference cannot be modified.
UM02 UnableToModifyPaymentServiceLevel - Service level element of payment type cannot be modified(former UnableToModifyBankOperationCode).
UM03 UnableToModifyCategoryPurpose - Category purpose element of payment type cannot be modified (former UnableToModifyInstructionCode).
UM04 UnableToModifyRequestedExecutionDate - RequestedExecutionDate cannot be modified.
UM05 UnableToModifyInterbankSettlementDate - InterbankSettlementDate cannot be modified (former UnableToModifyValueDate).
UM06 UnableToModifyInterbankSettlementAccount - SettlementAccount cannot be modified (former UnableToModifyInterbankSettlementAccount).
UM07 UnableToModifyDebtor - Debtor cannot be modified.
UM08 UnableToModifyDebtorAccount - DebtorAccount cannot be modified.
UM09 UnableToModifyInstructedReimbursementAgent - InstructedReimbursementAgent cannot be modified (former UnableToModifyReceiverCorrespondent).
UM10 UnableToModifyThirdReimbursementAgent - ThirdReimbursementAgent cannot be modified (former UnableToModifyThirdReimbursementInstitution).
UM11 UnableToModifyPaymentClearingChannel - Clearing Channel element of payment type cannot be modified (former UnableToModifyPaymentScheme)
UM12 UnableToModifyCreditorAgentAccount - Creditor agent account cannot be modified (former UnableToModifyAccountOfBeneficiaryInstitution)
UM13 UnableToModifyCreditor - Creditor cannot be modified.
UM14 UnableToModifyCreditorAccount - Creditor account cannot be modified.
UM15 UnableToModifyRemittanceInformation - Remittance information cannot be modified.
UM16 UnableToModifyPaymentPurpose - PaymentPurpose cannot be modified.
UM17 UnableToModifyChargeBearer - Charge bearer cannot be modified (former UnableToModifyDetailsOfCharges).
UM18 UnableToModifyInstructionForNextAgent - Instruction for next agent cannot be modified (former UnableToModifySenderToReceiver).
UM19 UnableToModifyInstructionForCreditorAgent - Instruction for creditor agent cannot be modified. (former UnableToModifyInstructionForFinalAgent).
UM20 InstructionCancelledSubmitNewInstruction - Used to inform of cancellation and request a new payment instruction. This should only be used if an agent does not want to modify a pending payment.
UM21 UnableToModifySubmitCancellation - Modification is not possible and the cancellation is requested.
UM22 UnableToModifyDebtorAgentAccount - Debtor agent account cannot be modified (applicable for direct debits).
UM23 UnableToModifyInterbankSettlementAmount - Interbank settlement amount cannot be modified.
UM24 UnableToModifyInstructionForDebtorAgent - Instruction for debtor agent cannot be modified (applicable for direct debits)
UM25 UnableToModifyRequestedCollectionDate - Requested collection date cannot be modified (applicable for direct debits)
UM26 UnableToModifyPaymentType - Payment type cannot be modified.
UM27 UnableToModifyInstructedAmount - Instructed or equivalent amount cannot be modified.
UM28 UnableToModifyPriority - Priority of payment message cannot be modified.

Enum"UM01""UM02""UM03""UM04""UM05""UM06""UM07""UM08""UM09""UM10"

{
  "schema": "string",
  "value": "UM01"
}

ModificationStatusReason

schemastring

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

Discriminator

valuestring

UM01 UnableToModifyRelatedReference - Related transaction reference cannot be modified.
UM02 UnableToModifyPaymentServiceLevel - Service level element of payment type cannot be modified(former UnableToModifyBankOperationCode).
UM03 UnableToModifyCategoryPurpose - Category purpose element of payment type cannot be modified (former UnableToModifyInstructionCode).
UM04 UnableToModifyRequestedExecutionDate - RequestedExecutionDate cannot be modified.
UM05 UnableToModifyInterbankSettlementDate - InterbankSettlementDate cannot be modified (former UnableToModifyValueDate).
UM06 UnableToModifyInterbankSettlementAccount - SettlementAccount cannot be modified (former UnableToModifyInterbankSettlementAccount).
UM07 UnableToModifyDebtor - Debtor cannot be modified.
UM08 UnableToModifyDebtorAccount - DebtorAccount cannot be modified.
UM09 UnableToModifyInstructedReimbursementAgent - InstructedReimbursementAgent cannot be modified (former UnableToModifyReceiverCorrespondent).
UM10 UnableToModifyThirdReimbursementAgent - ThirdReimbursementAgent cannot be modified (former UnableToModifyThirdReimbursementInstitution).
UM11 UnableToModifyPaymentClearingChannel - Clearing Channel element of payment type cannot be modified (former UnableToModifyPaymentScheme)
UM12 UnableToModifyCreditorAgentAccount - Creditor agent account cannot be modified (former UnableToModifyAccountOfBeneficiaryInstitution)
UM13 UnableToModifyCreditor - Creditor cannot be modified.
UM14 UnableToModifyCreditorAccount - Creditor account cannot be modified.
UM15 UnableToModifyRemittanceInformation - Remittance information cannot be modified.
UM16 UnableToModifyPaymentPurpose - PaymentPurpose cannot be modified.
UM17 UnableToModifyChargeBearer - Charge bearer cannot be modified (former UnableToModifyDetailsOfCharges).
UM18 UnableToModifyInstructionForNextAgent - Instruction for next agent cannot be modified (former UnableToModifySenderToReceiver).
UM19 UnableToModifyInstructionForCreditorAgent - Instruction for creditor agent cannot be modified. (former UnableToModifyInstructionForFinalAgent).
UM20 InstructionCancelledSubmitNewInstruction - Used to inform of cancellation and request a new payment instruction. This should only be used if an agent does not want to modify a pending payment.
UM21 UnableToModifySubmitCancellation - Modification is not possible and the cancellation is requested.
UM22 UnableToModifyDebtorAgentAccount - Debtor agent account cannot be modified (applicable for direct debits).
UM23 UnableToModifyInterbankSettlementAmount - Interbank settlement amount cannot be modified.
UM24 UnableToModifyInstructionForDebtorAgent - Instruction for debtor agent cannot be modified (applicable for direct debits)
UM25 UnableToModifyRequestedCollectionDate - Requested collection date cannot be modified (applicable for direct debits)
UM26 UnableToModifyPaymentType - Payment type cannot be modified.
UM27 UnableToModifyInstructedAmount - Instructed or equivalent amount cannot be modified.
UM28 UnableToModifyPriority - Priority of payment message cannot be modified.

Enum"UM01""UM02""UM03""UM04""UM05""UM06""UM07""UM08""UM09""UM10"

{
  "schema": "CODE",
  "value": "UM01"
}