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

CheckDigitVerificationReport

The response to a check digit verification request, containing the outcome of the performed verification.

outcomestringrequired

Indicates whether the check digit verification was successful or not.

PASSED: The provided data passed verification.

FAILED: The provided data failed verification.

SKIPPED: No verification was performed.

Enum"PASSED""FAILED""SKIPPED"

reasonInfoobject(VerificationReasonInfo)

Provides detailed information on a verification reason.

{
  "outcome": "PASSED",
  "reasonInfo": {
    "additionalInformation": "string",
    "reason": { … }
  }
}

Assignment

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

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

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

firstAgentobject(InstitutionIdentification)

{
  "assignee": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "assigner": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "firstAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  }
}

SchemeVerificationData

This object contains fields specific to the scheme being interacted with and determined by the chosen schema. Typically these are fields that are not standard within ISO20022 ACMT.023

schemastringrequired

Discriminator

checkCreditsAllowedboolean

Sets whether or not the response should indicate if credits are allowed on the account.

checkDebitsAllowedboolean

Sets whether or not the response should indicate if debits are allowed on the account.

checkOlderThanThreeMonthsboolean

Sets whether or not the response should indicate whether the account is older than 3 months.

initialsstring<= 70 characters

Initials of the individual account owner that is to be verified.

lastNamestring<= 70 characters

Family name of the individual account owner that is to be verified.

{
  "schema": "ZA_AVS",
  "checkCreditsAllowed": true,
  "checkDebitsAllowed": true,
  "checkOlderThanThreeMonths": true,
  "initials": "string",
  "lastName": "string"
}

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations