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

InvestigationStatusCancellationConfirmation

Indicates whether the cancellation of the assignment is confirmed or rejected. Used when responding to a prior request to cancel a case assignment

cancellationConfirmedbooleanrequired

statusTypestringrequired

Value"CANCELLATION_CONFIRMATION"

{
  "cancellationConfirmed": true,
  "statusType": "CANCELLATION_CONFIRMATION"
}

InvestigationExecutionCode

ACDA AcceptedDebitAuthorisation - Used when a creditor accepts the debit authorisation.
ACNR AcceptedClaimNonReceipt - The claim for non-receipt of a payment instruction is accepted.
ACVA AcceptedValueDateAdjustment - The claim for value date correction is accepted.
BIAS BatchInstructionAlreadySettled - Process a cancellation request but batch already settled.
CHRG ChargesDetailsProvided - Further charges details are provided to resolve the case.
CNCL CancelledAsPerRequest - Used when a requested cancellation is successful.
CONF ConfirmationOfPayment - Used when a payment has been checked and was correctly executed without any intervention.
CVAA CorrectValueDateAlreadyApplied - The original value date was correct.
CWFW CancellationWillFollow - Used when a payment will be cancelled to solve an investigation case.
FTNA CancellationRequestForwardedToTheNextAgent - "The cancellation request has been forwarded to the next agent for execution. This code should only be utilised where a Case Id is not present."
ICOV CoverInitiated - Used when a transfer of funds has been initiated (a cover payment) to resolve a case.
IDNE InstructionDoesNotExist - Process a Batch Cancellation "using an incorrect batch sequence number”.
IDUP InstructionIsDuplicate - Used when the requested check for a possible duplicate instruction is confirmed.
INFO AdditionalInformationSent - Used when additional information has been sent to the beneficiary of a payment.
IPAY PaymentInitiated - Used when the result of an investigation is, or will be, the initiation of a payment instruction.
IPYI PaymentInstructionInitiated - Used when a payment instruction (eg. MT103) has been initiated to resolve a case.
IVCR InvalidCancellationRequest - Process a cancellation request with incorrect reference to original batch.
MCOV CoverModified - Used when a transfer of funds has been modified (a cover payment) to resolve a case.
MODI ModifiedAsPerRequest - Used when a requested modification is successful.
MWFW ModificationWillFollow - Used when the payment will be modified to solve an investigation case.
NINF NoInformationAvailable - Used when no additional information is available.
PDCR PendingCancellationRequest - Used when a requested cancellation is pending.
PDNG Pending - Used to inform that a response to an investigation is pending.
PECR PartiallyExecutedCancellationRequest - Used when a requested cancellation has been partially executed.
PURP PurposeDetailsProvided - Further purpose details are provided to resolve the case.
RJCR RejectedCancellationRequest - Used when a requested cancellation has been rejected.
RJNR RejectedClaimNonReceipt - The claim for non-receipt of a payment instruction is rejected.
RJVA RejectedValueDateAdjustment - The claim for value date correction is rejected.
SMTC StatementEntryCorrect - Used when the entry in the statement is correct.
SMTI StatementEntryIncorrect - Used when the entry in the statement is incorrect and further information is provided with the resolution.
UWFW UnableToApplyWillFollow - Used when sender wants to respond to an assignment with an Unable To Apply workflow.

string(InvestigationExecutionCode)

ACDA AcceptedDebitAuthorisation - Used when a creditor accepts the debit authorisation.
ACNR AcceptedClaimNonReceipt - The claim for non-receipt of a payment instruction is accepted.
ACVA AcceptedValueDateAdjustment - The claim for value date correction is accepted.
BIAS BatchInstructionAlreadySettled - Process a cancellation request but batch already settled.
CHRG ChargesDetailsProvided - Further charges details are provided to resolve the case.
CNCL CancelledAsPerRequest - Used when a requested cancellation is successful.
CONF ConfirmationOfPayment - Used when a payment has been checked and was correctly executed without any intervention.
CVAA CorrectValueDateAlreadyApplied - The original value date was correct.
CWFW CancellationWillFollow - Used when a payment will be cancelled to solve an investigation case.
FTNA CancellationRequestForwardedToTheNextAgent - "The cancellation request has been forwarded to the next agent for execution. This code should only be utilised where a Case Id is not present."
ICOV CoverInitiated - Used when a transfer of funds has been initiated (a cover payment) to resolve a case.
IDNE InstructionDoesNotExist - Process a Batch Cancellation "using an incorrect batch sequence number”.
IDUP InstructionIsDuplicate - Used when the requested check for a possible duplicate instruction is confirmed.
INFO AdditionalInformationSent - Used when additional information has been sent to the beneficiary of a payment.
IPAY PaymentInitiated - Used when the result of an investigation is, or will be, the initiation of a payment instruction.
IPYI PaymentInstructionInitiated - Used when a payment instruction (eg. MT103) has been initiated to resolve a case.
IVCR InvalidCancellationRequest - Process a cancellation request with incorrect reference to original batch.
MCOV CoverModified - Used when a transfer of funds has been modified (a cover payment) to resolve a case.
MODI ModifiedAsPerRequest - Used when a requested modification is successful.
MWFW ModificationWillFollow - Used when the payment will be modified to solve an investigation case.
NINF NoInformationAvailable - Used when no additional information is available.
PDCR PendingCancellationRequest - Used when a requested cancellation is pending.
PDNG Pending - Used to inform that a response to an investigation is pending.
PECR PartiallyExecutedCancellationRequest - Used when a requested cancellation has been partially executed.
PURP PurposeDetailsProvided - Further purpose details are provided to resolve the case.
RJCR RejectedCancellationRequest - Used when a requested cancellation has been rejected.
RJNR RejectedClaimNonReceipt - The claim for non-receipt of a payment instruction is rejected.
RJVA RejectedValueDateAdjustment - The claim for value date correction is rejected.
SMTC StatementEntryCorrect - Used when the entry in the statement is correct.
SMTI StatementEntryIncorrect - Used when the entry in the statement is incorrect and further information is provided with the resolution.
UWFW UnableToApplyWillFollow - Used when sender wants to respond to an assignment with an Unable To Apply workflow.

Enum"ACDA""ACNR""ACVA""BIAS""CHRG""CNCL""CONF""CVAA""CWFW""FTNA"

"ACDA"

InvestigationStatusConfirmation

Specifies the status of the investigation, in a coded form

confirmationCodestring(InvestigationExecutionCode)required

ACDA AcceptedDebitAuthorisation - Used when a creditor accepts the debit authorisation.
ACNR AcceptedClaimNonReceipt - The claim for non-receipt of a payment instruction is accepted.
ACVA AcceptedValueDateAdjustment - The claim for value date correction is accepted.
BIAS BatchInstructionAlreadySettled - Process a cancellation request but batch already settled.
CHRG ChargesDetailsProvided - Further charges details are provided to resolve the case.
CNCL CancelledAsPerRequest - Used when a requested cancellation is successful.
CONF ConfirmationOfPayment - Used when a payment has been checked and was correctly executed without any intervention.
CVAA CorrectValueDateAlreadyApplied - The original value date was correct.
CWFW CancellationWillFollow - Used when a payment will be cancelled to solve an investigation case.
FTNA CancellationRequestForwardedToTheNextAgent - "The cancellation request has been forwarded to the next agent for execution. This code should only be utilised where a Case Id is not present."
ICOV CoverInitiated - Used when a transfer of funds has been initiated (a cover payment) to resolve a case.
IDNE InstructionDoesNotExist - Process a Batch Cancellation "using an incorrect batch sequence number”.
IDUP InstructionIsDuplicate - Used when the requested check for a possible duplicate instruction is confirmed.
INFO AdditionalInformationSent - Used when additional information has been sent to the beneficiary of a payment.
IPAY PaymentInitiated - Used when the result of an investigation is, or will be, the initiation of a payment instruction.
IPYI PaymentInstructionInitiated - Used when a payment instruction (eg. MT103) has been initiated to resolve a case.
IVCR InvalidCancellationRequest - Process a cancellation request with incorrect reference to original batch.
MCOV CoverModified - Used when a transfer of funds has been modified (a cover payment) to resolve a case.
MODI ModifiedAsPerRequest - Used when a requested modification is successful.
MWFW ModificationWillFollow - Used when the payment will be modified to solve an investigation case.
NINF NoInformationAvailable - Used when no additional information is available.
PDCR PendingCancellationRequest - Used when a requested cancellation is pending.
PDNG Pending - Used to inform that a response to an investigation is pending.
PECR PartiallyExecutedCancellationRequest - Used when a requested cancellation has been partially executed.
PURP PurposeDetailsProvided - Further purpose details are provided to resolve the case.
RJCR RejectedCancellationRequest - Used when a requested cancellation has been rejected.
RJNR RejectedClaimNonReceipt - The claim for non-receipt of a payment instruction is rejected.
RJVA RejectedValueDateAdjustment - The claim for value date correction is rejected.
SMTC StatementEntryCorrect - Used when the entry in the statement is correct.
SMTI StatementEntryIncorrect - Used when the entry in the statement is incorrect and further information is provided with the resolution.
UWFW UnableToApplyWillFollow - Used when sender wants to respond to an assignment with an Unable To Apply workflow.

Enum"ACDA""ACNR""ACVA""BIAS""CHRG""CNCL""CONF""CVAA""CWFW""FTNA"

statusTypestringrequired

Value"CONFIRMATION"

{
  "confirmationCode": "ACDA",
  "statusType": "CONFIRMATION"
}