Electrum Regulated Payments Partner API (21.0.2)

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-redoc.json

elpapi-partner-redoc.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

Schema

CaseAssignment

assigneeany(PartyInstitutionChoice)required

assignee.institutionobject(InstitutionIdentification)required

assignee.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignee.institution.addressobject(PostalAddress)

assignee.institution.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)

assignee.institution.branchobject(BranchIdentification)

assignee.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignee.institution.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).

assignee.institution.namestring<= 140 characters

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

assignee.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assignee.institution.memberIdstring<= 35 charactersDeprecated

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

assignee.schemastringrequired

Value"INSTITUTION"

Discriminator

assignerany(PartyInstitutionChoice)required

assigner.institutionobject(InstitutionIdentification)required

assigner.institution.additionalIdentificationsArray of objects(AccountIdentification)

assigner.institution.addressobject(PostalAddress)

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

assigner.institution.branchobject(BranchIdentification)

assigner.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assigner.institution.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).

assigner.institution.namestring<= 140 characters

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

assigner.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assigner.institution.memberIdstring<= 35 charactersDeprecated

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

assigner.schemastringrequired

Value"INSTITUTION"

Discriminator

creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

identificationstring<= 35 charactersrequired

Uniquely identifies a case assignment

{
  "assignee": {
    "party": { … },
    "schema": "PARTY"
  },
  "assigner": {
    "party": { … },
    "schema": "PARTY"
  },
  "creationDateTime": "2019-08-24T14:15:22Z",
  "identification": "string"
}

Case6

creatorany(PartyInstitutionChoice)

identificationstring<= 35 characters

reopenCaseIndicationboolean

Indicates whether or not the case was previously closed and is now re-opened

{
  "creator": {
    "party": { … },
    "schema": "PARTY"
  },
  "identification": "string",
  "reopenCaseIndication": true
}

ZaAcFiToFiPaymentCancellationPaymentSchemeData

cancellationTypestringrequired

Identifies the specific business process applicable to the cancellation request.

RECALL: A request to revoke a payment instruction that has not yet settled or is currently in tracking. If successful, the instruction is cancelled without financial movement (no settlement occurs). If the partner makes use of Electrum's collections capabilities, this type is only expected for outbound use.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents the case where a bank has experienced a technical issue that resulted in settled debit collections being processed incorrectly (e.g., a batch of debits was duplicated), and the industry bank is requesting that the partner bank correct the error.
A successful correction means the partner bank initiates a financial Payment Return to recover the funds from the industry bank in order to refund the debtor.
This case is notably different from standard recalls and disputes in that: (1) This strictly requires prior industry/PASA authorisation to invoke, (2) it may be rejected by the partner bank if the correction cannot be applied (e.g., original transaction not found, or the transaction was already reversed via a customer dispute), (3) partial reversals are not permitted, and (4) the bank from industry is limited to exactly 2 (two) retry attempts for the same transaction if an earlier request was rejected.

Enum"RECALL""SYSTEM_ERROR_CORRECTION_REQUEST"

{
  "cancellationType": "RECALL"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations