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

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"
  }
}

ZaEftPaymentReturnPaymentSchemeData

originalUserReferencestring

The original user reference associated with the returned payment. This value mirrors the userReference that was supplied on the initial EFT transaction.

returnTypestringrequired

Identifies the type of EFT payment return.

UNPAID: Occurs when a payment cannot be completed successfully by the homing bank such as due to insufficient funds or account closure. Note that it is impossible for Electrum to reject unpaids received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound unpaids.
DISPUTE: Occurs when there is a disagreement between the creditor and debtor regarding a payment and, after investigation with the assistance of their respective banks, the creditor's bank (in the case of a credit) or the debtor's bank (in the case of a debit) decides that the payment should be returned. As for unpaids, it is impossible for Electrum to reject disputes received from industry, so a negative payment return response results in a reconciliation exception for inbound disputes.
SYSTEM_ERROR_CORRECTION_REQUEST: Only expected for inbound use and represents the case where a bank from industry has experienced a technical issue that resulted in payments to or from the partner bank being reflected incorrectly (e.g. credits or debits were duplicated) and the industry bank is requesting that the partner bank attempt to correct the error. This case is notably different from unpaids and disputes in that (1) the system error correction request is expected to be best effort and may be rejected by the partner bank if the request cannot be honoured (e.g. due to insufficient funds) and (2) the bank from industry may retry system error correction requests for the same transaction on different days if an earlier request was rejected.
HOME_BACK: Occurs when a payment cannot be completed successfully at the operator such as a lack of information required to route to the correct homing bank. Note that it is impossible for Electrum to reject homebacks received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound homebacks.

Enum"UNPAID""DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST""HOME_BACK"

shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

userCodestring<= 4 characters

A code allocated by PayInc. Sometimes also referred to as BankCode. May equal Installation code for in-house operation.

{
  "originalUserReference": "string",
  "returnType": "UNPAID",
  "shortenedCreditorAccountNumber": "stringstrin",
  "shortenedDebtorAccountNumber": "stringstrin",
  "userCode": "stri"
}