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

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

RemittanceInformation

structuredArray of objects(StructuredRemittanceInformation)

unstructuredArray of strings

{
  "structured": [
    { … }
  ],
  "unstructured": [
    "string"
  ]
}

BaseOriginalTransactionData

amountsobject(TransactionAmounts)

creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)

paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

paymentTypeInformationobject(PaymentTypeInformation)

remittanceInformationobject(RemittanceInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

{
  "amounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "paymentMethod": "CreditTransfer",
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "settlementDate": "2019-08-24",
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  }
}

OriginalTransactionData

Contains key elements related to the original transaction that is being referred to.

amountsobject(TransactionAmounts)

creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)

paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

paymentTypeInformationobject(PaymentTypeInformation)

remittanceInformationobject(RemittanceInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

creditorobject(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.

debtorobject(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.

{
  "amounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "paymentMethod": "CreditTransfer",
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "settlementDate": "2019-08-24",
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "creditor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "debtor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  }
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations