Electrum Regulated Payments Partner API (29.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

Download OpenAPI description

elpapi-partner.json

elpapi-partner.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

account-management

Operations that involve customer account information.

Operations

sanctions-assessment

Operations related to the processing of sanctions assessment for payment transactions.

Operations

mandate-management

Operations related to the lifecycle management of direct debit mandates.

Operations

Schema

TcibPaymentReturnPaymentScheme

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.
TCIB: Transactions Cleared on an Immediate Basis scheme.

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

{
  "schema": "ZA_RTC"
}

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.
TCIB: Transactions Cleared on an Immediate Basis scheme.

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

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

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations