EPC API for calling Electrum (17.1.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

Download OpenAPI description

epc-elpapi-redoc.json

epc-elpapi-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Mock server

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

Payments API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

Schema

CreditTransferInitiationStatusRequest

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

includeIndividualCreditsStatusesboolean

A flag to indicate if the status of each individual credit transfer, as per Electrum's view, should be reflected in the response

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

paymentInformationIdstring(UUID)required

Universally unique identifier to provide an end-to-end reference to the bulk initiation. This identifier remains the same for all messages related to the bulk transaction. Note: this is distinct from the UETR's of the individual transactions.

schemastringrequired

Value"CreditTransferInitiationStatusRequest"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "includeIndividualCreditsStatuses": true,
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "paymentInformationId": "string",
  "schema": "CreditTransferInitiationStatusRequest"
}

RequestToPayInitiationInstruction

Initiation instruction object. This is a striped down version of the requestToPay model with the fields that can be inferred from the bulk information removed.

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

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.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).

creditor.identificationobject(PartyIdentification)

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

creditor.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.

creditor.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).

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAgentobject(InstitutionIdentification)required

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

creditorAgent.addressobject(PostalAddress)

creditorAgent.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)

creditorAgent.branchobject(BranchIdentification)

creditorAgent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

creditorAgent.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).

creditorAgent.namestring<= 140 characters

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

creditorAgent.companyRegistrationstring<= 35 charactersDeprecated

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

creditorAgent.memberIdstring<= 35 charactersDeprecated

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

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

debtorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

debtorAccount.identificationobject(BankingIdentifier)

debtorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

debtorAccount.proxyobject(NonBankingIdentifier)

debtorAccount.typeobject(AccountType)

debtorAgentobject(InstitutionIdentification)

expiryDateTimestring(date-time)required

Date and time at which the request to pay expires. Some schemes may still permit a payment after the request to pay expires. Upon expiry, the following schemes will reject an associated payment: ZA_RPP. The date must be formatted as defined by date-time in RFC3339

instructionForDebtorAgentArray of objects(CreditorAgentInstruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

paymentTypeInformationobject(PaymentTypeInformation)required

paymentTypeInformation.categoryPurposeobject(CategoryPurpose)

paymentTypeInformation.localInstrumentobject(LocalInstrumentType)

paymentTypeInformation.serviceLevelArray of objects(ServiceLevel)

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)required

remittanceInformation.structuredArray of objects(StructuredRemittanceInformation)

remittanceInformation.unstructuredArray of strings

requestToPayConditionsobject(RequestToPayConditions)required

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

requestToPayConditions.maxAmountobject(Amount)required

requestToPayConditions.maxAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

requestToPayConditions.maxAmount.valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

requestToPayConditions.minAmountobject(Amount)required

requestToPayConditions.minAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

requestToPayConditions.minAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

taxobject(TaxInformation)

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

{
  "creditor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "instructionForDebtorAgent": [
    { … }
  ],
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "purpose": {
    "schema": "string",
    "value": "BKDF"
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "requestToPayConditions": {
    "maxAmount": { … },
    "minAmount": { … }
  },
  "tax": {
    "totalAmount": { … }
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}

RequestToPayInitiation

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

bulkPaymentSchemeNamestring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

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

numberOfTransactionsinteger>= 1

The total number of transactions in the bulk.

requestToPayInformationIdstring(UUID)required

Universally unique identifier to identify the bulk collection itself.

requestToPayInitiationInstructionsArray of objects(RequestToPayInitiationInstruction)non-emptyrequired

List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.

requestToPayInitiationInstructions[].creditorobject(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.

requestToPayInitiationInstructions[].creditor.addressobject(PostalAddress)

requestToPayInitiationInstructions[].creditor.contactDetailsobject(ContactDetails)

requestToPayInitiationInstructions[].creditor.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).

requestToPayInitiationInstructions[].creditor.identificationobject(PartyIdentification)

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

requestToPayInitiationInstructions[].creditor.knownAsNamestring[ 1 .. 140 ] characters

requestToPayInitiationInstructions[].creditor.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).

requestToPayInitiationInstructions[].creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

requestToPayInitiationInstructions[].creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

requestToPayInitiationInstructions[].creditorAccount.identificationobject(BankingIdentifier)

requestToPayInitiationInstructions[].creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

requestToPayInitiationInstructions[].creditorAccount.proxyobject(NonBankingIdentifier)

requestToPayInitiationInstructions[].creditorAccount.typeobject(AccountType)

requestToPayInitiationInstructions[].creditorAgentobject(InstitutionIdentification)required

requestToPayInitiationInstructions[].creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

requestToPayInitiationInstructions[].creditorAgent.addressobject(PostalAddress)

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

requestToPayInitiationInstructions[].creditorAgent.branchobject(BranchIdentification)

requestToPayInitiationInstructions[].creditorAgent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

requestToPayInitiationInstructions[].creditorAgent.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).

requestToPayInitiationInstructions[].creditorAgent.namestring<= 140 characters

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

requestToPayInitiationInstructions[].creditorAgent.companyRegistrationstring<= 35 charactersDeprecated

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

requestToPayInitiationInstructions[].creditorAgent.memberIdstring<= 35 charactersDeprecated

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

requestToPayInitiationInstructions[].debtorobject(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.

requestToPayInitiationInstructions[].debtorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

requestToPayInitiationInstructions[].debtorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

requestToPayInitiationInstructions[].debtorAccount.identificationobject(BankingIdentifier)

requestToPayInitiationInstructions[].debtorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

requestToPayInitiationInstructions[].debtorAccount.proxyobject(NonBankingIdentifier)

requestToPayInitiationInstructions[].debtorAccount.typeobject(AccountType)

requestToPayInitiationInstructions[].debtorAgentobject(InstitutionIdentification)

requestToPayInitiationInstructions[].expiryDateTimestring(date-time)required

requestToPayInitiationInstructions[].instructionForDebtorAgentArray of objects(CreditorAgentInstruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent.

requestToPayInitiationInstructions[].messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

requestToPayInitiationInstructions[].messageIdentifiers.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

requestToPayInitiationInstructions[].messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

requestToPayInitiationInstructions[].paymentTypeInformationobject(PaymentTypeInformation)required

requestToPayInitiationInstructions[].paymentTypeInformation.categoryPurposeobject(CategoryPurpose)

requestToPayInitiationInstructions[].paymentTypeInformation.localInstrumentobject(LocalInstrumentType)

requestToPayInitiationInstructions[].paymentTypeInformation.serviceLevelArray of objects(ServiceLevel)

requestToPayInitiationInstructions[].purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

requestToPayInitiationInstructions[].remittanceInformationobject(RemittanceInformation)required

requestToPayInitiationInstructions[].remittanceInformation.structuredArray of objects(StructuredRemittanceInformation)

requestToPayInitiationInstructions[].remittanceInformation.unstructuredArray of strings

requestToPayInitiationInstructions[].requestToPayConditionsobject(RequestToPayConditions)required

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

requestToPayInitiationInstructions[].requestToPayConditions.maxAmountobject(Amount)required

requestToPayInitiationInstructions[].requestToPayConditions.maxAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

requestToPayInitiationInstructions[].requestToPayConditions.maxAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

requestToPayInitiationInstructions[].requestToPayConditions.minAmountobject(Amount)required

requestToPayInitiationInstructions[].requestToPayConditions.minAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

requestToPayInitiationInstructions[].requestToPayConditions.minAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

requestToPayInitiationInstructions[].taxobject(TaxInformation)

requestToPayInitiationInstructions[].transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

requestToPayInitiationInstructions[].transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

requestToPayInitiationInstructions[].transactionIdentifiers.instructionIdentificationstring<= 35 characters

requestToPayInitiationInstructions[].transactionIdentifiers.transactionIdentificationstring<= 35 characters

requestToPayInitiationInstructions[].transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "bulkPaymentSchemeName": "ZA_RTC",
  "initiatingParty": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "numberOfTransactions": 1,
  "requestToPayInformationId": "string",
  "requestToPayInitiationInstructions": [
    { … }
  ]
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations