TaxRemittance

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.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

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": { … }
  }
}

StructuredRemittanceInformation

additionalRemittanceInformationArray of strings<= 3 items

creditorReferenceobject(CreditorReference)

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

originatorReferencestring<= 35 characters

An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.

referredDocumentAmountobject(ReferredDocumentAmount)

referredDocumentsArray of objects(ReferredDocument)

taxRemittanceobject(TaxRemittance)

{
  "additionalRemittanceInformation": [
    "string"
  ],
  "creditorReference": {
    "reference": "string",
    "type": { … }
  },
  "invoicer": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "originatorReference": "string",
  "referredDocumentAmount": {
    "duePayableAmount": { … },
    "remittedAmount": { … }
  },
  "referredDocuments": [
    { … }
  ],
  "taxRemittance": {
    "creditor": { … },
    "date": "2019-08-24",
    "debtor": { … },
    "referenceNumber": "string",
    "sequenceNumber": 0,
    "totalTaxAmount": { … },
    "totalTaxableBaseAmount": { … },
    "ultimateDebtor": { … }
  }
}

EPC API for receiving Electrum calls (17.1.0)

credit-transfer

identifier-determination

Schema

AuthorisedTaxParty

TaxRemittance

StructuredRemittanceInformation

transactional

request-to-pay

financial

bulk

refund