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

ChargeTypeCode

schemastringrequired

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

valuestringrequired

BRKF (BrokerageFee): Fee paid to a broker for services provided.
BTCH (Batch): Fee paid for processing a batch of transactions.
COMM (Commission): Fee paid for services provided.
SUMM (Summation): Summation of individual fees.
AMND (Amendment): Payment order was changed based on request to do so from the (original) sending bank or as a result of receiving amended information from the (original) sending bank.
CFEE (CancellationFee): Used when fees are assessed for cancellation of a payment.
CLEF (ClearingFee): Used when fees are assessed for standard processing of financial institution type transfers.
INVS (Investigation): Charges related to the processing of an investigation case/inquiry.
INTE (Interest): Interest related charges.
NSTP (NonSTPCharges): Charge for a payment that required an intervention during processing.
DEBT (BorneByDebtor): Claim is being submitted in response to receiving a customer credit transfer with DEBT in Charge Bearer code.
TELE (TelecommunicationCharges): Charges relating to the most appropriate and efficient means of telecommunications available, for example, SWIFT, telex, telephone, facsimile, as determined by the party executing the payment instruction.
ACCM (AccMaintenanceFee): Account maintenance fee.
RECH (ReportingCharges): Charge for a reporting message (camt.05X).

Enum"BRKF""BTCH""COMM""SUMM""AMND""CFEE""CLEF""INVS""INTE""NSTP"

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

ChargeType

schemastringrequired

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

Discriminator

valuestringrequired

BRKF (BrokerageFee): Fee paid to a broker for services provided.
BTCH (Batch): Fee paid for processing a batch of transactions.
COMM (Commission): Fee paid for services provided.
SUMM (Summation): Summation of individual fees.
AMND (Amendment): Payment order was changed based on request to do so from the (original) sending bank or as a result of receiving amended information from the (original) sending bank.
CFEE (CancellationFee): Used when fees are assessed for cancellation of a payment.
CLEF (ClearingFee): Used when fees are assessed for standard processing of financial institution type transfers.
INVS (Investigation): Charges related to the processing of an investigation case/inquiry.
INTE (Interest): Interest related charges.
NSTP (NonSTPCharges): Charge for a payment that required an intervention during processing.
DEBT (BorneByDebtor): Claim is being submitted in response to receiving a customer credit transfer with DEBT in Charge Bearer code.
TELE (TelecommunicationCharges): Charges relating to the most appropriate and efficient means of telecommunications available, for example, SWIFT, telex, telephone, facsimile, as determined by the party executing the payment instruction.
ACCM (AccMaintenanceFee): Account maintenance fee.
RECH (ReportingCharges): Charge for a reporting message (camt.05X).

Enum"BRKF""BTCH""COMM""SUMM""AMND""CFEE""CLEF""INVS""INTE""NSTP"

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

Charge

agentobject(InstitutionIdentification)required

agent.additionalIdentificationsArray of objects(AccountIdentification)

agent.addressobject(PostalAddress)

agent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

agent.branchobject(BranchIdentification)

agent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

agent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

agent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

agent.companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

agent.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

amountobject(Amount)required

amount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amount.valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

typeobject(ChargeType)

{
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "amount": {
    "currency": "string",
    "value": 0.1
  },
  "type": {
    "schema": "string",
    "value": "BRKF"
  }
}