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

Languages
Servers
Mock server

https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/

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

Schema

AuthorisedTaxParty

registrationIdentificationstring[ 1 .. 35 ] characters

Unique identification, as assigned by an organisation, to unambiguously identify a party

taxIdentificationstring[ 1 .. 35 ] characters

Tax identification number

taxTypestring[ 1 .. 35 ] characters

Type of tax payer.

authorisationobject(TaxAuthorisation)
{
  "registrationIdentification": "string",
  "taxIdentification": "string",
  "taxType": "string",
  "authorisation": {
    "name": "string",
    "title": "string"
  }
}

TaxRemittance

creditorobject(TaxParty)
datestring(date)

Date by which tax is due

debtorobject(AuthorisedTaxParty)
referenceNumberstring[ 1 .. 140 ] characters

Tax reference information that is specific to a taxing agency.

sequenceNumberinteger(int64)

Sequential number of the tax report.

totalTaxAmountobject(Amount)
totalTaxableBaseAmountobject(Amount)
ultimateDebtorobject(AuthorisedTaxParty)
{
  "creditor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string"
  },
  "date": "2019-08-24",
  "debtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  },
  "referenceNumber": "string",
  "sequenceNumber": 0,
  "totalTaxAmount": {
    "currency": "string",
    "value": 0.1
  },
  "totalTaxableBaseAmount": {
    "currency": "string",
    "value": 0.1
  },
  "ultimateDebtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  }
}

StructuredRemittanceInformation

additionalRemittanceInformationArray of strings<= 3 items
creditorReferenceobject(CreditorReference)
invoicerobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

originatorReferencestring<= 35 characters

An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.

referredDocumentAmountobject(ReferredDocumentAmount)
referredDocumentsArray of objects(ReferredDocument)
taxRemittanceobject(TaxRemittance)
{
  "additionalRemittanceInformation": [
    "string"
  ],
  "creditorReference": {
    "reference": "string",
    "type": { … }
  },
  "invoicer": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "originatorReference": "string",
  "referredDocumentAmount": {
    "duePayableAmount": { … },
    "remittedAmount": { … }
  },
  "referredDocuments": [
    { … }
  ],
  "taxRemittance": {
    "creditor": { … },
    "date": "2019-08-24",
    "debtor": { … },
    "referenceNumber": "string",
    "sequenceNumber": 0,
    "totalTaxAmount": { … },
    "totalTaxableBaseAmount": { … },
    "ultimateDebtor": { … }
  }
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd