Electrum Regulated Payments Partner API (17.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

Download OpenAPI description

elpapi-partner.json

elpapi-partner.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

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

Partner API sandbox

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

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

Schema

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"

ChargeTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

BRKF (BrokerageFee): Fee paid to a broker for services provided.
BTCH (Batch): Fee paid for processing a batch of transactions.
COMM (Commission): Fee paid for services provided.
SUMM (Summation): Summation of individual fees.
AMND (Amendment): Payment order was changed based on request to do so from the (original) sending bank or as a result of receiving amended information from the (original) sending bank.
CFEE (CancellationFee): Used when fees are assessed for cancellation of a payment.
CLEF (ClearingFee): Used when fees are assessed for standard processing of financial institution type transfers.
INVS (Investigation): Charges related to the processing of an investigation case/inquiry.
INTE (Interest): Interest related charges.
NSTP (NonSTPCharges): Charge for a payment that required an intervention during processing.
DEBT (BorneByDebtor): Claim is being submitted in response to receiving a customer credit transfer with DEBT in Charge Bearer code.
TELE (TelecommunicationCharges): Charges relating to the most appropriate and efficient means of telecommunications available, for example, SWIFT, telex, telephone, facsimile, as determined by the party executing the payment instruction.
ACCM (AccMaintenanceFee): Account maintenance fee.
RECH (ReportingCharges): Charge for a reporting message (camt.05X).

Enum"BRKF""BTCH""COMM""SUMM""AMND""CFEE""CLEF""INVS""INTE""NSTP"

{
  "schema": "string",
  "value": "BRKF"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations