EPC API for receiving Electrum calls (17.1.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Download OpenAPI description

epc-elpapi-partner-redoc.json

epc-elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

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

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

ContactDetails

emailAddressstring(email)

mobileNumberstring(PhoneNumber)^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

phoneNumberstring(PhoneNumber)^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

{
  "emailAddress": "user@example.com",
  "mobileNumber": "string",
  "phoneNumber": "string"
}

OrganisationIdentifierBic

An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages - Business identifier code (BIC).

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

{
  "BIC": "string",
  "schema": "string"
}

OrganisationIdentifierLei

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

LEIstring[A-Z0-9]{18,18}[0-9]{2,2}required

schemastringrequired

Indicates the identifier as a LEI organisation identifier, always LEI

{
  "LEI": "string",
  "schema": "string"
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations