Electrum Regulated Payments API (21.0.2)

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

This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

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 this document.
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 the Electrum Regulated Payments Partner API.

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. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.

Download OpenAPI description

elpapi-redoc.json

elpapi-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Payments API sandbox

https://example.com/path/payments/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

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

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

Operations

refund

Operations related to the refund of a prior successful financial transaction.

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

ZaCdvCheckDigitVerificationRequest

Performs a check digit verification on the provided account number and branch code.

If the accountType is not provided, it will be inferred using the identifier and branch. The following account type map applies for ZA CDV checks:

Industry	Electrum
Current	CACC
Savings	SVGS
Transmission	TRAN
Bond	LOAN
Subscription_Share	OTHR

accountTypeobject(AccountType)

branchobject(BranchIdentification)required

branch.addressobject(PostalAddress)

branch.identificationstringrequired

Unique and unambiguous identification of a branch of a financial institution.

branch.namestring<= 140 characters

The name by which this branch is known and is usually used to identify the branch.

identifierobject(GenericAccountIdentifier)required

identifier.issuerstring<= 35 characters

The entity that assigns the identification

identifier.schemastringrequired

Identifies this account identifier as generic, always GENERIC

identifier.schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

identifier.valuestring[ 1 .. 40 ] charactersrequired

verificationSchemestringrequired

The name of the verification scheme to be used to verify the provided data.

{
  "accountType": {
    "schema": "string",
    "value": "CACC"
  },
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "identifier": {
    "issuer": "string",
    "schema": "string",
    "scheme": { … },
    "value": "string"
  },
  "verificationScheme": "string"
}

CheckDigitVerificationRequest

A request that includes information to be verified using the provided verification routine.

accountTypeobject(AccountType)

branchobject(BranchIdentification)required

branch.addressobject(PostalAddress)

branch.identificationstringrequired

Unique and unambiguous identification of a branch of a financial institution.

branch.namestring<= 140 characters

The name by which this branch is known and is usually used to identify the branch.

identifierobject(GenericAccountIdentifier)required

identifier.issuerstring<= 35 characters

The entity that assigns the identification

identifier.schemastringrequired

Identifies this account identifier as generic, always GENERIC

identifier.schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

identifier.valuestring[ 1 .. 40 ] charactersrequired

verificationSchemestringrequired

The name of the verification scheme to be used to verify the provided data.

Discriminator

{
  "accountType": {
    "schema": "string",
    "value": "CACC"
  },
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "identifier": {
    "issuer": "string",
    "schema": "string",
    "scheme": { … },
    "value": "string"
  },
  "verificationScheme": "ZA_CDV"
}

ExternalVerificationReason1Code

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

string(ExternalVerificationReason1Code)[ 1 .. 4 ] characters

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

Enum"AC01""AGNT""DUPL""AG01""BNOR""DS28""FF01""MS03""NORR""NR01"

"AC01"

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations