Outbound Debits and Credits

The following scenarios describe the payment transaction flows between you as the originating bank and Electrum.

Successful Outbound Credit or Debit

Important

Electrum currently supports only same-day outbound credits and debits.

outbound pay success

You send Electrum either:

An outboundCreditTransfer request to the outbound-credit-transfer endpoint for a credit transaction (CreditTransfer schema), or

An outboundDirectDebit request to the outbound/direct-debit endpoint in the case of a debit transaction (DirectDebit schema; see below.)

CreditTransfer Schema

required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (SupplementaryData) A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
required	object (TransactionAmounts)
required	object (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.
required	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
required	object (InstitutionIdentification)
required	object (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.
	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
required	object (InstitutionIdentification)
	object (InstitutionIdentification)
	object (InstitutionIdentification)
	Array of objects (Instruction) >= 0 items Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
	Array of objects (InstitutionIdentification) <= 3 characters Agents between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2
required	object (CreditTransferPaymentScheme) Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.
	object (PaymentTypeInformation)
	Array of objects (InstitutionIdentification) <= 3 characters Agent(s) between the debtor's agent and the instructing agent.
	object (PurposeType) Specifies the underlying reason for the payment transaction
	object (RemittanceInformation)
schema required	string Value: "CreditTransfer"
settlementDate	string <date> Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.
	object (TaxInformation)

DirectDebit Schema

required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (SupplementaryData) A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
required	object (TransactionAmounts)
required	object (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.
	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
required	object (InstitutionIdentification)
required	object (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.
required	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
required	object (InstitutionIdentification)
	object (InstitutionIdentification)
	object (InstitutionIdentification)
	Array of objects (InstitutionIdentification) <= 3 characters Agents between the debtor's agent and the creditor's agent. If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2.
	object (MandateInformation) Provides details of the direct debit mandate signed between the creditor and the debtor. NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the `ZA_EFT` scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
required	object (DirectDebitPaymentScheme) Designates which scheme a direct debit is associated with and describes scheme-specific information for the direct debit.
	object (PaymentTypeInformation)
	object (PurposeType) Specifies the underlying reason for the payment transaction
	object (RemittanceInformation)
requestedCollectionDate	string <date> Date and time at which the creditor requests that the amount of money is to be collected from the debtor.
schema required	string Value: "DirectDebit"
sequenceType	string (SequenceTypeCode) Identifies the direct debit sequence: `FRST` : First collection of a series of direct debit instructions. `RCUR` : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor. `FNAL` : Final collection of a series of direct debit instructions. `OOFF` : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction. `RPRE` : Collection used to represent previously reversed or returned direct debit transactions. Enum: "FRST" "RCUR" "FNAL" "OOFF" "RPRE"
settlementDate	string <date> Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

Electrum returns a positive response with HTTP status code 202.

Electrum validates the transaction limits and validates the account information using the CDV specification.

After Electrum has successfully validated and processed the transaction within Electrum, Electrum sends either:

An outboundCreditTransferResponse message to the /outbound/credit-transfer-response endpoint (PaymentStatusReport schema) in the case of a credit payment.

An outboundDirectDebitResponse message to the /outbound/direct-debit-response endpoint (PaymentStatusReport schema) in the case of a debit payment.

PaymentStatusReport Schema

required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (SupplementaryData) A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
	object (InstitutionIdentification)
	object (InstitutionIdentification)
	object (OriginalTransactionData) Contains key elements related to the original transaction that is being referred to.
required	object (PaymentStatusReportPaymentScheme) Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
schema required	string Value: "PaymentStatusReport"
required	object (Status)

Electrum will send the message repeatedly via a store-and-forward queue until you acknowledge receipt.

You respond with an HTTP status code of 202.

The transaction is stored in a database until an adequate number of transactions has been received, or a time limit has been reached. Electrum then groups the transactions into an EFT data file and sends the file to BankservAfrica immediately if the day's processing window is still open; if not then Electrum sends the file once the next processing window is open.

Error Handling

No Response from Electrum

outbound no response electrum

If you do not receive an acknowledgement or negative acknowledgement from Electrum in response to a CreditTransfer or DirectDebit message, then you can retry the transaction up to set number of times before considering the transaction failed. Such a transaction will be considered a reconciliation exception.

Negative Acknowledgement from Electrum

outbound nack electrum

If you receive a negative acknowledgement (NACK; HTTP 5xx or retryable HTTP 4xx) from Electrum in response to a CreditTransfer or DirectDebit message, then you can retry the transaction up to a set number of times before considering the transaction failed. Such a transaction will be considered a reconciliation exception.

Note

You can retry the message for all HTTP 5xx and 4xx NACKs that are considered transient (i.e., recoverable). For HTTP 4xx NACKs that are not recoverable, the error will be resolved manually.

No PaymentStatusReport from Electrum

outbound no PSR from Electrum

If you do not receive a PaymentStatusReport message from Electrum before the reconciliation window closes, then the transaction will be considered a reconciliation exception.

No HTTP Response from the Originating Bank

outbound no http from OB

If Electrum does not receive an acknowledgement or negative acknowledgement from you in response to a PaymentStatusReport then Electrum will continue to send the message via a store-and-forward queue. If there is still no response before the reconciliation window closes then the transaction will be considered a reconciliation exception.

Error Validating Account Details

outbound account validation error

A payment may be rejected for various reasons during the account validation stage; for example, if the transaction limits were exceeded. If you receive a PaymentStatusReport message containing the status code RJCT from Electrum, then you can retry the transaction after rectifying the discrepancies, or abort the transaction.

No Response from BankservAfrica

If Electrum does not receive a response after sending an EFT file to BankservAfrica, Electrum will notify BankservAfrica that a file has been sent and an issue has occurred. The issue will be resolved between BankservAfrica and Electrum. The transaction will then proceed as normal.