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

BaseTransactionMessage

A model containing the foundational elements shared across messages relating to transactions.

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.

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.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}

CreditorAgentInstruction

Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent

codestring

CHQB: (PayCreditorByCheque) (Ultimate) creditor must be paid by cheque.
HOLD: (HoldCashForCreditor) Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.
PHOB: (PhoneBeneficiary) Please advise/contact (ultimate) creditor/claimant by phone.
PRTK: (PayerTokenRequested) Indicates that a payer token is requested/used.
RECI: (ReceiverCustomerInformation) Further information regarding the intended recipient.
TELB: (Telecom) Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.
TKCM: (TokenCounterpartyMismatch) Token found with counterparty mismatch.
TKSG: (TokenSingleUse) Single Use Token already used.
TKSP: (TokenSuspended) Token found with suspended status.
TKVE: (TokenValueLimitExceeded) Token found with value limit rule violation.
TKXP: (TokenExpired) Token expired.
TOKN: (Token) Token information.
VLTK: (TokenValidation) Additional validation information to be used in conjunction with the token.
SEID: (SecondaryIdentification): Use of Secondary Identification of Creditor Account (which may relate to Head Office Collection Account, Building Society Roll Number or Credit Card Primary Account Number).
RT14: A ZA-RPP scheme-specific instruction regarding fraud scores.

Enum"CHQB""HOLD""PHOB""PRTK""RECI""TELB""TKCM""TKSG""TKSP""TKVE"

informationstring[ 1 .. 140 ] characters

Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.

{
  "code": "CHQB",
  "information": "string"
}

ChargeBearer

DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme

string(ChargeBearer)

DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme

Enum"DEBT""CRED""SHAR""SLEV"

"DEBT"

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations