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

ClearingSystemIdentification

schemastringrequired

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

Discriminator
valuestring(ExternalClearingSystemIdentification1Code)required
  • MA (MoroccoClearingSystemID): Clearing System ID used in Morocco
  • ATBLZ (AustrianBankleitzahl): Bank Branch code used in Austria.
  • AUBSB (AustralianBankStateBranchCodeBSB): Bank Branch code used in Australia.
  • CACPA (CanadianPaymentsAssociationPaymentRoutingNumber): Bank Branch code used in Canada.
  • CHBCC (SwissFinancialInstitutionIdentificationShort): Financial Institution Identification (IID) used in Switzerland, without check digit.
  • CHSIC (SwissFinancialInstitutionIdentificationLong): Financial Institution Identification (IID) used in Switzerland, including check digit.
  • CNAPS (CNAPSIdentifier): Bank Branch code used in China.
  • DEBLZ (GermanBankleitzahl): Bank Branch code used in Germany.
  • ESNCC (SpanishDomesticInterbankingCode): Bank Branch code used in Spain.
  • GBDSC (UKDomesticSortCode): Bank Branch code used in the UK.
  • GRBIC (HelenicBankIdentificationCode): Bank Branch code used in Greece.
  • HKNCC (HongKongBankCode): Bank Branch code used in Hong Kong.
  • IENCC (IrishNationalClearingCode): Bank Branch code used in Ireland.
  • INFSC (IndianFinancialSystemCode): Bank Branch code used in India.
  • ITNCC (ItalianDomesticIdentificationCode): Bank Branch code used in Italy.
  • JPZGN (JapanZenginClearingCode): Bank Branch code used in Japan.
  • NZNCC (NewZealandNationalClearingCode): Bank Branch code used in New Zealand.
  • PLKNR (PolishNationalClearingCode): Bank Branch code used in Poland.
  • PTNCC (PortugueseNationalClearingCode): Bank Branch code used in Portugal.
  • RUCBC (RussianCentralBankIdentificationCode): Bank Branch code used in Russia.
  • SESBA (SwedenBankgiroClearingCode): Bank Branch code used in Sweden.
  • SGIBG (IBGSortCode): Bank Branch code used in Singapore.
  • THCBC (ThaiCentralBankIdentificationCode): Bank Identification code used in Thailand.
  • TWNCC (FinancialInstitutionCode): Bank Branch code used in Taiwan.
  • USABA (UnitedStatesRoutingNumberFedwireNACHA): Routing Transit number assigned by the ABA for US financial institutions.
  • USPID (CHIPSParticipantIdentifier): Bank identifier used by CHIPs in the US.
  • ZANCC (SouthAfricanNationalClearingCode): Bank Branch code used in South Africa.
  • NZRSA (NewZealandRTGSClearingCode): RTGS settlement account used in New Zealand.
  • MZBMO (BancoDeMocambiqueRTGS): Banco de Mocambique RTGS system.
  • CNCIP (CrossBorderInterbankPaymentSystem): Chinese Cross-border Interbank Payment System (CIPS) Identifier.
  • KRBOK (SouthKoreaCentralBankIdentificationCode): Participant Institution code used by BOK-Wire+ in South Korea.
  • BRISP (BrazilianBankIdentificationCode): Bank Identification code used in Brazil (ISPB).
  • NACSC (NamibiaClearingSystemCode): Clearing system Identification code used in Namibia.
  • ZWTSS (ZimbabweClearingSystemCode): System Identification Code used in the Zimbabwe settlement system.
  • AD (AndorraClearingSystemID): Clearing System ID used in Andorra
  • EGNCC (EgyptianNationalClearingCode): RTGS Clearing system Identification code used in Egypt.
  • AE (UnitedArabEmiratesClearingSystemID): Clearing System ID used in United Arab Emirates
  • AF (AfghanistanClearingSystemID): Clearing System ID used in Afghanistan
  • AI (AntiguaandBermudaClearingSystemID): Clearing System ID used in Antigua and Bermuda
  • AL (AlbaniaClearingSystemID): Clearing System ID used in Albania
  • AM (ArmeniaClearingSystemID): Clearing System ID used in Armenia
  • AO (AngolaClearingSystemID): Clearing System ID used in Angola
  • AR (ArgentinaClearingSystemID): Clearing System ID used in Argentina
  • AS (AmericanSamoaClearingSystemID): Clearing System ID used in American Samoa
  • AW (ArubaClearingSystemID): Clearing System ID used in Aruba
  • AZ (AzerbaijanClearingSystemID): Clearing System ID used in Azerbaijan
  • BA (BosniaandHerzegovinaClearingSystemID): Clearing System ID used in Bosnia and Herzegovina
  • BD (BangladeshClearingSystemID): Clearing System ID used in Bangladesh
  • BG (BulgariaClearingSystemID): Clearing System ID used in Bulgaria
  • BH (BahrainClearingSystemID): Clearing System ID used in Bahrain
  • BI (BurundiClearingSystemID): Clearing System ID used in Burundi
  • BL (SaintBarthelemyClearingSystemID): Clearing System ID used in Saint Barthelemy
  • BM (BermudaClearingSystemID): Clearing System ID used in Bermuda
  • BN (BruneiDarussalamClearingSystemID): Clearing System ID used in Brunei Darussalam
  • BO (BoliviaClearingSystemID): Clearing System ID used in Bolivia
  • BS (BahamasClearingSystemID): Clearing System ID used in Bahamas
  • BT (BhutanClearingSystemID): Clearing System ID used in Bhutan
  • BW (BotswanaClearingSystemID): Clearing System ID used in Botswana
  • BY (BelarusClearingSystemID): Clearing System ID used in Belarus
  • BZ (BelizeClearingSystemID): Clearing System ID used in Belize
  • CD (DemocraticRepublicofTheCongoClearingSystemID): Clearing System ID used in Democratic Republic of The Congo
  • CL (ChileClearingSystemID): Clearing System ID used in Chile
  • CO (ColombiaClearingSystemID): Clearing System ID used in Colombia
  • CR (CostaRicaClearingSystemID): Clearing System ID used in Costa Rica
  • CV (CaboVerdeClearingSystemID): Clearing System ID used in Cabo Verde
  • CW (CuracaoClearingSystemID): Clearing System ID used in Curacao
  • CY (CyprusClearingSystemID): Clearing System ID used in Cyprus
  • CZ (CzechRepublicClearingSystemID): Clearing System ID used in Czech Republic
  • DO (DominicanRepublicClearingSystemID): Clearing System ID used in Dominican Republic
  • DZ (AlgeriaClearingSystemID): Clearing System ID used in Algeria
  • EC (EcuadorClearingSystemID): Clearing System ID used in Ecuador
  • EE (EstoniaClearingSystemID): Clearing System ID used in Estonia
  • GE (GeorgiaClearingSystemID): Clearing System ID used in Georgia
  • GH (GhanaClearingSystemID): Clearing System ID used in Ghana
  • GN (GuineaClearingSystemID): Clearing System ID used in Guinea
  • GT (GuatemalaClearingSystemID): Clearing System ID used in Guatemala
  • GY (GuyanaClearingSystemID): Clearing System ID used in Guyana
  • HN (HondurasClearingSystemID): Clearing System ID used in Honduras
  • HR (CroatiaClearingSystemID): Clearing System ID used in Croatia
  • HT (HaitiClearingSystemID): Clearing System ID used in Haiti
  • HU (HungaryClearingSystemID): Clearing System ID used in Hungary
  • ID (IndonesiaClearingSystemID): Clearing System ID used in Indonesia
  • IL (IsraelClearingSystemID): Clearing System ID used in Israel
  • IQ (IraqClearingSystemID): Clearing System ID used in Iraq
  • IS (IcelandClearingSystemID): Clearing System ID used in Iceland
  • JM (JamaicaClearingSystemID): Clearing System ID used in Jamaica
  • JO (JordanClearingSystemID): Clearing System ID used in Jordan
  • KE (KenyaClearingSystemID): Clearing System ID used in Kenya
  • KG (TheKyrgyzRepublicClearingSystemID): Clearing System ID used in The Kyrgyz Republic
  • KH (CambodiaClearingSystemID): Clearing System ID used in Cambodia
  • KM (ComorosClearingSystemID): Clearing System ID used in Comoros
  • KW (KuwaitClearingSystemID): Clearing System ID used in Kuwait
  • KZ (KazakhstanClearingSystemID): Clearing System ID used in Kazakhstan
  • LB (LebanonClearingSystemID): Clearing System ID used in Lebanon
  • LK (SriLankaClearingSystemID): Clearing System ID used in Sri Lanka
  • LR (LiberiaClearingSystemID): Clearing System ID used in Liberia
  • LS (LesothoClearingSystemID): Clearing System ID used in Lesotho
  • LT (LithuaniaClearingSystemID): Clearing System ID used in Lithuania
  • LV (LatviaClearingSystemID): Clearing System ID used in Latvia
  • LY (LibyaClearingSystemID): Clearing System ID used in Libya
  • MD (MoldovaClearingSystemID): Clearing System ID used in Moldova
  • ME (MontenegroClearingSystemID): Clearing System ID used in Montenegro
  • MG (MadagascarClearingSystemID): Clearing System ID used in Madagascar
  • MK (NorthMacedoniaClearingSystemID): Clearing System ID used in North Macedonia
  • MN (MongoliaClearingSystemID): Clearing System ID used in Mongolia
  • MO (MacaoClearingSystemID): Clearing System ID used in Macao
  • MR (MauritaniaClearingSystemID): Clearing System ID used in Mauritania
  • MT (MaltaClearingSystemID): Clearing System ID used in Malta
  • MU (MauritiusClearingSystemID): Clearing System ID used in Mauritius
  • MW (MalawiClearingSystemID): Clearing System ID used in Malawi
  • MX (MexicoClearingSystemID): Clearing System ID used in Mexico
  • MY (MalaysiaClearingSystemID): Clearing System ID used in Malaysia
  • NG (NigeriaClearingSystemID): Clearing System ID used in Nigeria
  • NI (NicaraguaClearingSystemID): Clearing System ID used in Nicaragua
  • NP (NepalClearingSystemID): Clearing System ID used in Nepal
  • OM (OmanClearingSystemID): Clearing System ID used in Oman
  • PA (PanamaClearingSystemID): Clearing System ID used in Panama
  • PE (PeruClearingSystemID): Clearing System ID used in Peru
  • PG (PapuaNewGuineaClearingSystemID): Clearing System ID used in Papua New Guinea
  • PH (PhilippinesClearingSystemID): Clearing System ID used in Philippines
  • PK (PakistanClearingSystemID): Clearing System ID used in Pakistan
  • PS (PalestineClearingSystemID): Clearing System ID used in Palestine
  • PY (ParaguayClearingSystemID): Clearing System ID used in Paraguay
  • QA (QatarClearingSystemID): Clearing System ID used in Qatar
  • RO (RomaniaClearingSystemID): Clearing System ID used in Romania
  • RS (SerbiaClearingSystemID): Clearing System ID used in Serbia
  • RW (RwandaClearingSystemID): Clearing System ID used in Rwanda
  • SA (SaudiArabiaClearingSystemID): Clearing System ID used in Saudi Arabia
  • SC (SeychellesClearingSystemID): Clearing System ID used in Seychelles
  • SD (SudanClearingSystemID): Clearing System ID used in Sudan
  • SI (SloveniaClearingSystemID): Clearing System ID used in Slovenia
  • SK (SlovakiaClearingSystemID): Clearing System ID used in Slovakia
  • SL (SierraLeoneClearingSystemID): Clearing System ID used in Sierra Leone
  • ST (SaoTomeandPrincipeClearingSystemID): Clearing System ID used in Sao Tome and Principe
  • SV (ElSalvadorClearingSystemID): Clearing System ID used in El Salvador
  • SZ (EswatiniClearingSystemID): Clearing System ID used in Eswatini
  • TJ (TajikistanClearingSystemID): Clearing System ID used in Tajikistan
  • TL (Timor): LesteClearingSystemID Clearing System ID used in Timor-Leste
  • TM (TurkmenistanClearingSystemID): Clearing System ID used in Turkmenistan
  • TN (TunisiaClearingSystemID): Clearing System ID used in Tunisia
  • TR (TurkeyClearingSystemID): Clearing System ID used in Turkey
  • TT (TrinidadandTobagoClearingSystemID): Clearing System ID used in Trinidad and Tobago
  • TZ (TanzaniaClearingSystemID): Clearing System ID used in Tanzania
  • UA (UkraineClearingSystemID): Clearing System ID used in Ukraine
  • UG (UgandaClearingSystemID): Clearing System ID used in Uganda
  • UY (UruguayClearingSystemID): Clearing System ID used in Uruguay
  • UZ (UzbekistanClearingSystemID): Clearing System ID used in Uzbekistan
  • VA (VaticanCityClearingSystemID): Clearing System ID used in Vatican City
  • VE (VenezuelaClearingSystemID): Clearing System ID used in Venezuela
  • VN (VietnamClearingSystemID): Clearing System ID used in Vietnam
  • XK (KosovoClearingSystemID): Clearing System ID used in Kosovo
  • ZM (ZambiaClearingSystemID): Clearing System ID used in Zambia
  • MARPA (MoroccoRTGSParticipantIdentificationCode): RTGS participant identification code used in the Kingdom of Morocco.
  • MARAC (MoroccoRTGSNationalClearingCode): RTGS clearing system identification used in the Kingdom of Morocco.
Enum"MA""ATBLZ""AUBSB""CACPA""CHBCC""CHSIC""CNAPS""DEBLZ""ESNCC""GBDSC"
{
  "schema": "CODE",
  "value": "MA"
}

ClearingSystemMemberIdentification

clearingSystemobject(ClearingSystemIdentification)
memberIdstring<= 35 charactersrequired

Identification of a member of a clearing system.

{
  "clearingSystem": {
    "schema": "string",
    "value": "MA"
  },
  "memberId": "string"
}

InstitutionIdentification

additionalIdentificationsArray of objects(AccountIdentification)
addressobject(PostalAddress)
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)

branchobject(BranchIdentification)
clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
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).

namestring<= 140 characters

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

companyRegistrationstring<= 35 charactersDeprecated

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

memberIdstring<= 35 charactersDeprecated

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

{
  "additionalIdentifications": [
    { … }
  ],
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "room": "string",
    "streetName": "string",
    "subDepartment": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "bicfi": "string",
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "clearingSystemMemberId": {
    "clearingSystem": { … },
    "memberId": "string"
  },
  "companyRegistration": "string",
  "lei": "string",
  "memberId": "string",
  "name": "string"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd