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

TaxAuthorisation

namestring[ 1 .. 140 ] characters

Name of the tax payer or tax payer's authorised representative

titlestring[ 1 .. 35 ] characters

Title or position of the tax payer or tax payer's authorised representative

{
  "name": "string",
  "title": "string"
}

AuthorisedTaxParty

registrationIdentificationstring[ 1 .. 35 ] characters

Unique identification, as assigned by an organisation, to unambiguously identify a party

taxIdentificationstring[ 1 .. 35 ] characters

Tax identification number

taxTypestring[ 1 .. 35 ] characters

Type of tax payer.

authorisationobject(TaxAuthorisation)

{
  "registrationIdentification": "string",
  "taxIdentification": "string",
  "taxType": "string",
  "authorisation": {
    "name": "string",
    "title": "string"
  }
}

TaxRemittance

creditorobject(TaxParty)

datestring(date)

Date by which tax is due

debtorobject(AuthorisedTaxParty)

referenceNumberstring[ 1 .. 140 ] characters

Tax reference information that is specific to a taxing agency.

sequenceNumberinteger(int64)

Sequential number of the tax report.

totalTaxAmountobject(Amount)

totalTaxableBaseAmountobject(Amount)

ultimateDebtorobject(AuthorisedTaxParty)

{
  "creditor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string"
  },
  "date": "2019-08-24",
  "debtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  },
  "referenceNumber": "string",
  "sequenceNumber": 0,
  "totalTaxAmount": {
    "currency": "string",
    "value": 0.1
  },
  "totalTaxableBaseAmount": {
    "currency": "string",
    "value": 0.1
  },
  "ultimateDebtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  }
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations