Electrum Regulated Payments Events API (17.1.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

Download OpenAPI description

elpapi-events.json

elpapi-events.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Mock server

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

Payments API sandbox

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

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

Operations

Schema

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"

ServiceLevelCode

schemastringrequired

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

valuestring(ExternalServiceLevel1Code)required

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"

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

ServiceLevel

schemastringrequired

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

Discriminator

valuestring(ExternalServiceLevel1Code)required

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"

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