Electrum Regulated Payments Partner API (21.0.2)

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-redoc.json

elpapi-partner-redoc.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

PartyChoice

partyobject(Party)required

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

party.addressobject(PostalAddress)

party.contactDetailsobject(ContactDetails)

party.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

party.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

party.knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

party.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

schemastringrequired

Value"PARTY"

{
  "party": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "schema": "PARTY"
}

PartyInstitutionChoice

institutionobject(InstitutionIdentification)required

institution.additionalIdentificationsArray of objects(AccountIdentification)

institution.addressobject(PostalAddress)

institution.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

institution.branchobject(BranchIdentification)

institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

institution.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

institution.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

institution.companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

institution.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

schemastringrequired

Value"INSTITUTION"

Discriminator

{
  "institution": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "schema": "INSTITUTION"
}

CaseAssignment

assigneeany(PartyInstitutionChoice)required

assignee.institutionobject(InstitutionIdentification)required

assignee.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignee.institution.addressobject(PostalAddress)

assignee.institution.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

assignee.institution.branchobject(BranchIdentification)

assignee.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignee.institution.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

assignee.institution.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

assignee.institution.companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

assignee.institution.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

assignee.schemastringrequired

Value"INSTITUTION"

Discriminator

assignerany(PartyInstitutionChoice)required

assigner.institutionobject(InstitutionIdentification)required

assigner.institution.additionalIdentificationsArray of objects(AccountIdentification)

assigner.institution.addressobject(PostalAddress)

assigner.institution.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

assigner.institution.branchobject(BranchIdentification)

assigner.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assigner.institution.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

assigner.institution.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

assigner.institution.companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

assigner.institution.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

assigner.schemastringrequired

Value"INSTITUTION"

Discriminator

creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

identificationstring<= 35 charactersrequired

Uniquely identifies a case assignment

{
  "assignee": {
    "party": { … },
    "schema": "PARTY"
  },
  "assigner": {
    "party": { … },
    "schema": "PARTY"
  },
  "creationDateTime": "2019-08-24T14:15:22Z",
  "identification": "string"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations