Electrum Regulated Payments Partner API (18.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

Schema

BankingIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

Discriminator

schemeobject(GenericAccountIdentificationScheme)

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

valuestring[ 1 .. 40 ] charactersrequired

{
  "issuer": "string",
  "schema": "GENERIC",
  "scheme": {
    "schema": "string",
    "value": "AIIN"
  },
  "value": "string"
}

ExternalCashAccountType1Code

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

string(ExternalCashAccountType1Code)

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

"CACC"

AccountTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestring(ExternalCashAccountType1Code)required

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

{
  "schema": "string",
  "value": "CACC"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations