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

LocalInstrumentTypeCode

schemastringrequired

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

valuestringrequired

0000 - BusinessPayment
0001 - ConvertedBankPayment
0002 - StandingOrder
0090 - MassPaymentBeneficiary
0091 - MassPaymentOurs
0092 - MassPaymentShared
0220 - StandingAuthorisationGeneral
0221 - OneOffAuthorisation
0222 - StandingAuthorisationCompanies
0223 - StandingAuthorisationLotteries
0224 - OneOffAuthorisationCharities
0225 - OneOffAuthorisationTuitionFees
0226 - OneOffAuthorisationConstructionIndustry
0227 - StandingAuthorisationCompaniesWithoutDebtorRevocationRight
04 - PreauthorisedDirectDebitDE
05 - NonPreauthorisedDirectDebitDE
08 - PreauthorisedDirectDebitOrdinaireNormalClearing4Day
19 - BusinessToCustomerDirectDebit
58 - BusinessToBusinessDirectDebit
60 - RecoveredBillofExchangeorPromissoryNote
82 - NonPreauthorisedDirectDebitAT
83 - PreauthorisedDirectDebitAT
85 - PreauthorisedDirectDebitAccéléréAcceleratedClearing2DayOrdinaireNormalClearing4Day
89 - PreauthorisedDirectDebitVérifiéVerifiedClearing
AC01 - IncorrectAccountNumber
ACCEPT - PaymentViaAcceptgiroOwnedByCurrence
ADD - AuthenticatedDirectDebit
ARC - AccountsReceivableCheck
ASTI - AncillarySystemTransferInitiation
B2B - SEPABusinessToBusinessDirectDebit
B2BAMIPM - SEPAB2BDirectDebitAMI
BACP - BackupPayment
BPA - BatchPaymentsAruba
BSE - PaperlessChequeCollection
BTR - BankTransfer
CARD - CardClearing
CCD - CashConcentrationOrDisbursementCorporateCounterparty
CCI - CashConcentrationIntragroup
CHN - TruncatedChecks
CIE - CustomerInitiatedEntry
CKS - CheckSameDaySettlementWire
CLSCCPERX - CLSClearedFXForEurex
CLSCCPLCH - CLSClearedFXForLCH
COR1 - SEPADirectDebit1DaySettlement
CORAMIPM - SEPACoreDirectDebitAMI
CORE - SEPADirectDebitCore
CPP - CashPerPost
CR1AMIPM - SEPACoreD1DirectDebitAMI
CRP - CreditTransferPreferred
CTP - CustomerTransferPlus
CTR - CustomerTransfer
CTX - CorporateTradeExchange
DDFA - DirectDebitFixedAmount
DDMC - DirectDebitConfirmedElectronicMandate
DDMP - DirectDebitPaperMandateWithPaperAuthorisation
DDMU - DirectDebitUnconfirmedElectronicMandate
DDNR - CoreNoRefund
DDT - DirectDebits
DEP - DepositToSendersAccount
DRB - BankToBankDrawdownRequestOrResponseNonvalue
DRC - CustomerOrCorporateDrawdownRequestOrResponseNonvalue
DRW - DrawdownResponseValueToHonorADrawdownRequest
FADAMIPM - SEPAFADirectDebitAMI
FFR - FedFundsReturned
FFS - FedFundsSold
GST - TruncatedCreditTransfers
IAT - InternationalACH
ICMC - IncidentManagementCorrection
IDEAL - PaymentsViaInternetOwnedByCurrence
IN - CrossBorderCustomerCreditTransfer
INST - InstantCreditTransfer
INSTIDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransfer
INSTNT01 - InstantCreditTransferNotTimeCritical
INSTNT01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferNotTimeCritical
INSTTC01 - InstantCreditTransferTimeCritical
INSTTC01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferTimeCritical
IPA - InstantPaymentsAruba
ISE - ImageBasedChequeCollection
ITP - InstantCreditTransferPreferred
MANP - MandatedPayment
NLDO - DutchDomesticBulkPayment
NLGOV - DirectDebitInitiatedByTheGovernmentWithSpecialConditions
NLUP - DutchUrgentPayment
ONCL - Overnight
PERI - PaymentWithERI
POP - PointOfPurchase
POS - PointOfSale
PPD - PrearrangedPaymentOrDepositConsumerCounterparty
RCK - RepresentedCheckEntry
RDD - ReturnedDirectDebits
RIBA - NonPreauthorisedDirectDebitRIBA
RIDO - PreauthorisedRevocableDirectDebit
RIDV - PreauthorisedRevocableUrgentDirectDebit
RTR - ReturnedCreditTransfers
SBTI - SettlementBankTransferInitiation
SCN - RevokedTruncatedChecks
SDCL - SameDayClearedPayments
SDD - RevokedDirectDebits
SDN - PaymentsViaStandaardDigitaleNota
SGT - RevokedTruncatedCreditTransfers
SRD - RevokedReturnedDirectDebits
SRT - RevokedReturnedCreditTransfers
STR - RevokedCreditTransfers
SVC - NonValueServiceMessage
TEL - TelephoneInitiatedEntry
TRF - CreditTransfers
UDD - UnauthenticatedDirectDebit
WEB - InternetInitiatedEntry

Enum"0000""0001""0002"909192"0220""0221""0222""0223"

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

LocalInstrumentType

schemastringrequired

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

Discriminator

valuestringrequired

0000 - BusinessPayment
0001 - ConvertedBankPayment
0002 - StandingOrder
0090 - MassPaymentBeneficiary
0091 - MassPaymentOurs
0092 - MassPaymentShared
0220 - StandingAuthorisationGeneral
0221 - OneOffAuthorisation
0222 - StandingAuthorisationCompanies
0223 - StandingAuthorisationLotteries
0224 - OneOffAuthorisationCharities
0225 - OneOffAuthorisationTuitionFees
0226 - OneOffAuthorisationConstructionIndustry
0227 - StandingAuthorisationCompaniesWithoutDebtorRevocationRight
04 - PreauthorisedDirectDebitDE
05 - NonPreauthorisedDirectDebitDE
08 - PreauthorisedDirectDebitOrdinaireNormalClearing4Day
19 - BusinessToCustomerDirectDebit
58 - BusinessToBusinessDirectDebit
60 - RecoveredBillofExchangeorPromissoryNote
82 - NonPreauthorisedDirectDebitAT
83 - PreauthorisedDirectDebitAT
85 - PreauthorisedDirectDebitAccéléréAcceleratedClearing2DayOrdinaireNormalClearing4Day
89 - PreauthorisedDirectDebitVérifiéVerifiedClearing
AC01 - IncorrectAccountNumber
ACCEPT - PaymentViaAcceptgiroOwnedByCurrence
ADD - AuthenticatedDirectDebit
ARC - AccountsReceivableCheck
ASTI - AncillarySystemTransferInitiation
B2B - SEPABusinessToBusinessDirectDebit
B2BAMIPM - SEPAB2BDirectDebitAMI
BACP - BackupPayment
BPA - BatchPaymentsAruba
BSE - PaperlessChequeCollection
BTR - BankTransfer
CARD - CardClearing
CCD - CashConcentrationOrDisbursementCorporateCounterparty
CCI - CashConcentrationIntragroup
CHN - TruncatedChecks
CIE - CustomerInitiatedEntry
CKS - CheckSameDaySettlementWire
CLSCCPERX - CLSClearedFXForEurex
CLSCCPLCH - CLSClearedFXForLCH
COR1 - SEPADirectDebit1DaySettlement
CORAMIPM - SEPACoreDirectDebitAMI
CORE - SEPADirectDebitCore
CPP - CashPerPost
CR1AMIPM - SEPACoreD1DirectDebitAMI
CRP - CreditTransferPreferred
CTP - CustomerTransferPlus
CTR - CustomerTransfer
CTX - CorporateTradeExchange
DDFA - DirectDebitFixedAmount
DDMC - DirectDebitConfirmedElectronicMandate
DDMP - DirectDebitPaperMandateWithPaperAuthorisation
DDMU - DirectDebitUnconfirmedElectronicMandate
DDNR - CoreNoRefund
DDT - DirectDebits
DEP - DepositToSendersAccount
DRB - BankToBankDrawdownRequestOrResponseNonvalue
DRC - CustomerOrCorporateDrawdownRequestOrResponseNonvalue
DRW - DrawdownResponseValueToHonorADrawdownRequest
FADAMIPM - SEPAFADirectDebitAMI
FFR - FedFundsReturned
FFS - FedFundsSold
GST - TruncatedCreditTransfers
IAT - InternationalACH
ICMC - IncidentManagementCorrection
IDEAL - PaymentsViaInternetOwnedByCurrence
IN - CrossBorderCustomerCreditTransfer
INST - InstantCreditTransfer
INSTIDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransfer
INSTNT01 - InstantCreditTransferNotTimeCritical
INSTNT01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferNotTimeCritical
INSTTC01 - InstantCreditTransferTimeCritical
INSTTC01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferTimeCritical
IPA - InstantPaymentsAruba
ISE - ImageBasedChequeCollection
ITP - InstantCreditTransferPreferred
MANP - MandatedPayment
NLDO - DutchDomesticBulkPayment
NLGOV - DirectDebitInitiatedByTheGovernmentWithSpecialConditions
NLUP - DutchUrgentPayment
ONCL - Overnight
PERI - PaymentWithERI
POP - PointOfPurchase
POS - PointOfSale
PPD - PrearrangedPaymentOrDepositConsumerCounterparty
RCK - RepresentedCheckEntry
RDD - ReturnedDirectDebits
RIBA - NonPreauthorisedDirectDebitRIBA
RIDO - PreauthorisedRevocableDirectDebit
RIDV - PreauthorisedRevocableUrgentDirectDebit
RTR - ReturnedCreditTransfers
SBTI - SettlementBankTransferInitiation
SCN - RevokedTruncatedChecks
SDCL - SameDayClearedPayments
SDD - RevokedDirectDebits
SDN - PaymentsViaStandaardDigitaleNota
SGT - RevokedTruncatedCreditTransfers
SRD - RevokedReturnedDirectDebits
SRT - RevokedReturnedCreditTransfers
STR - RevokedCreditTransfers
SVC - NonValueServiceMessage
TEL - TelephoneInitiatedEntry
TRF - CreditTransfers
UDD - UnauthenticatedDirectDebit
WEB - InternetInitiatedEntry

Enum"0000""0001""0002"909192"0220""0221""0222""0223"

{
  "schema": "CODE",
  "value": "0000"
}

ExternalServiceLevel1Code

BKTR (BookTransaction): Payment through internal book transfer.
G001 (TrackedCustomerCreditTransfer): Tracked Customer Credit Transfer.
G002 (TrackedStopAndRecall): Tracked Stop and Recall
G003 (TrackedOutboundCorporateTransfer): Tracked Outbound Corporate Transfer.
G004 (TrackedFinancialInstitutionTransfer): Tracked Financial Institution Transfer.
NPCA (NordicPaymentsCouncilAreaTransfer): Payments must be executed following the NPC Area Payment scheme.
NUGP (NonurgentPriorityPayment): Payment must be executed as a non-urgent transaction with priority settlement.
NURG (NonurgentPayment): Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.
PRPT (EBAPriorityService): Transaction must be processed according to the EBA Priority Service.
SDVA (SameDayValue): Payment must be executed with same day value to the creditor.
SEPA (SingleEuroPaymentsArea): Payment must be executed following the Single Euro Payments Area scheme.
SVDE (DomesticChequeClearingAndSettlement): Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland.
URGP (UrgentPayment): Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.
URNS (UrgentPaymentNetSettlement): Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.
INST (InstantCreditTransferOrInstantDirectDebit): Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.
SRTP (ServiceRequestToPay): Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).
SVAT (ScheckVerarbeitungAustria): Scheck Verarbeitung Austria (Cheque Processing).
G006 (TrackedCaseManagement): Specifies the service conditions applicable to a tracked exceptions and investigations case.
G007 (TrackedInboundCustomerCreditTransfer): Specifies the service level for a tracked inbound customer credit transfer.
G005 (TrackedInstantCustomerCreditTransfer): Tracked Instant Customer Credit Transfer.
G009 (TrackedLowValueCrossBorderCustomerCreditTransfer): Specifies the service level for a tracked low-value cross-border customer credit transfer.
WFSM (WaitForSettlement): Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.
EOLO (EuroOneLegOut): Payment is executed following a Euro One-Leg Out Scheme.
SPLI (SplitPayment): A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.

string(ExternalServiceLevel1Code)

BKTR (BookTransaction): Payment through internal book transfer.
G001 (TrackedCustomerCreditTransfer): Tracked Customer Credit Transfer.
G002 (TrackedStopAndRecall): Tracked Stop and Recall
G003 (TrackedOutboundCorporateTransfer): Tracked Outbound Corporate Transfer.
G004 (TrackedFinancialInstitutionTransfer): Tracked Financial Institution Transfer.
NPCA (NordicPaymentsCouncilAreaTransfer): Payments must be executed following the NPC Area Payment scheme.
NUGP (NonurgentPriorityPayment): Payment must be executed as a non-urgent transaction with priority settlement.
NURG (NonurgentPayment): Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.
PRPT (EBAPriorityService): Transaction must be processed according to the EBA Priority Service.
SDVA (SameDayValue): Payment must be executed with same day value to the creditor.
SEPA (SingleEuroPaymentsArea): Payment must be executed following the Single Euro Payments Area scheme.
SVDE (DomesticChequeClearingAndSettlement): Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland.
URGP (UrgentPayment): Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.
URNS (UrgentPaymentNetSettlement): Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.
INST (InstantCreditTransferOrInstantDirectDebit): Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.
SRTP (ServiceRequestToPay): Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).
SVAT (ScheckVerarbeitungAustria): Scheck Verarbeitung Austria (Cheque Processing).
G006 (TrackedCaseManagement): Specifies the service conditions applicable to a tracked exceptions and investigations case.
G007 (TrackedInboundCustomerCreditTransfer): Specifies the service level for a tracked inbound customer credit transfer.
G005 (TrackedInstantCustomerCreditTransfer): Tracked Instant Customer Credit Transfer.
G009 (TrackedLowValueCrossBorderCustomerCreditTransfer): Specifies the service level for a tracked low-value cross-border customer credit transfer.
WFSM (WaitForSettlement): Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.
EOLO (EuroOneLegOut): Payment is executed following a Euro One-Leg Out Scheme.
SPLI (SplitPayment): A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.

Enum"BKTR""G001""G002""G003""G004""NPCA""NUGP""NURG""PRPT""SDVA"

"BKTR"

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations