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

OriginalTransactionData

Contains key elements related to the original transaction that is being referred to.

amountsobject(TransactionAmounts)

creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)

creditorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)

debtorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

paymentTypeInformationobject(PaymentTypeInformation)

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

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

creditorobject(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.

debtorobject(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.

initiatingPartyobject(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.

{
  "amounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "creditorAgentAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtorAgentAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "paymentMethod": "CreditTransfer",
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "purpose": {
    "schema": "string",
    "value": "BKDF"
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "settlementDate": "2019-08-24",
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "creditor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "debtor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "initiatingParty": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  }
}

ZaAcPaymentReturnPaymentSchemeData

Scheme-specific data for Authenticated Collections (DebiCheck) payment returns.

returnTypestringrequired

Identifies the type of Authenticated Collections payment return (pacs.004).

DISPUTE: Occurs when a Payer (debtor) successfully disputes a processed Authenticated Collections debit instruction at their bank. Under AC clearing rules, a dispute action is strictly limited to a small set of valid reasons. Two such cases are: the collection amount was incorrect (ReturnReasonTypeCode AM02 - 'not allowed amount') or the collection date was incorrect (ReturnReasonTypeCode DT01 - 'invalid date'). The Debtor Bank initiates this payment return to reverse the funds from the Creditor.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents a payment return that is generated as the successful financial resolution of a System Error Correction (Bank Error) process. In this scenario, the Creditor Bank (after obtaining mandatory industry/PASA authorisation) previously submitted a cancellation request due to a technical issue, such as an erroneously duplicated debit batch. This payment return is the subsequent financial reversal initiated by the Debtor Bank to recover the erroneously collected funds from the Creditor in order to refund the debtor.

Enum"DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST"

userReferencestring<= 30 characters^[\u0020-\u007A]*$

A reference for the payment return that will appear on statements. This is mapped to the RmtInf/Ustrd field. Allowed characters are limited to printable ASCII (space through 'z').

{
  "returnType": "DISPUTE",
  "userReference": "string"
}

ZaAcPaymentReturnPaymentScheme

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"

schemeDataobject(ZaAcPaymentReturnPaymentSchemeData)required

Scheme-specific data for Authenticated Collections (DebiCheck) payment returns.

schemeData.returnTypestringrequired

Identifies the type of Authenticated Collections payment return (pacs.004).

DISPUTE: Occurs when a Payer (debtor) successfully disputes a processed Authenticated Collections debit instruction at their bank. Under AC clearing rules, a dispute action is strictly limited to a small set of valid reasons. Two such cases are: the collection amount was incorrect (ReturnReasonTypeCode AM02 - 'not allowed amount') or the collection date was incorrect (ReturnReasonTypeCode DT01 - 'invalid date'). The Debtor Bank initiates this payment return to reverse the funds from the Creditor.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents a payment return that is generated as the successful financial resolution of a System Error Correction (Bank Error) process. In this scenario, the Creditor Bank (after obtaining mandatory industry/PASA authorisation) previously submitted a cancellation request due to a technical issue, such as an erroneously duplicated debit batch. This payment return is the subsequent financial reversal initiated by the Debtor Bank to recover the erroneously collected funds from the Creditor in order to refund the debtor.

Enum"DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST"

schemeData.userReferencestring<= 30 characters^[\u0020-\u007A]*$

A reference for the payment return that will appear on statements. This is mapped to the RmtInf/Ustrd field. Allowed characters are limited to printable ASCII (space through 'z').

{
  "schema": "ZA_RTC",
  "schemeData": {
    "returnType": "DISPUTE",
    "userReference": "string"
  }
}