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

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

VerificationOutcome

Indicates whether the information provided in the verification request was correct (PASSED) or was incorrect (FAILED). If it was incorrect, a reason is provided.

schemastring

Discriminator

reasonInfoobject(VerificationReasonInfo)

Provides detailed information on a verification reason.

{
  "schema": "FAILED",
  "reasonInfo": {
    "additionalInformation": "string",
    "reason": { … }
  }
}

ExternalVerificationReason1Code

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

string(ExternalVerificationReason1Code)[ 1 .. 4 ] characters

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

Enum"AC01""AGNT""DUPL""AG01""BNOR""DS28""FF01""MS03""NORR""NR01"

"AC01"

VerificationReasonCode

schemastringrequired

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

valuestring(ExternalVerificationReason1Code)[ 1 .. 4 ] charactersrequired

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

Enum"AC01""AGNT""DUPL""AG01""BNOR""DS28""FF01""MS03""NORR""NR01"

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