On-Us debits

EFT on-us debits occur when a payee with an account held at a certain bank debits a payer's account held at the same bank.

Note

On-us (same-day) credits can be processed directly between the bank's internal systems without making use of Electrum's processing functionality. This is because credits can always be processed immediately without waiting for an end-of-day processing window. However, on-us debits should be processed via Electrum's payments engine, as Electrum's can hold onto all debits (both on-us debits and inbound off-us debits received from BankservAfrica), for processing in the debits processing window after all credits have been finalised.

The transaction does not proceed through BankservAfrica as the accounts are held at the same bank. However, different sectors of the bank may be involved at different points in the process.

Successful On-Us Debits

on-us debit success

You send Electrum an outboundDirectDebit request to the outbound/direct-debit endpoint (DirectDebit schema; see below.)

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 account information using the CDV specification.

After Electrum has successfully validated and processed the transaction within Electrum, Electrum sends an outboundDirectDebitResponse message to you via the /outbound/direct-debit-response endpoint (PaymentStatusReport schema).

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 202.

Electrum stores the transaction in a database until the next processing window is open so that the transaction can be processed with the other debit transactions.

The debit transactions are placed in a queue to be processed.

When the transaction reaches the head of the processing queue, Electrum sends an inboundDirectDebit request to you via the inbound/direct-debit endpoint (DirectDebit schema).

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.

You respond with an HTTP status code 202.

After you have successfully processed the transaction (debited the relevant account), you send Electrum an inboundDirectDebitResponse message to the /inbound/direct-debit-response endpoint (PaymentStatusReport schema).

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 returns an HTTP status code 202 to acknowledge receipt of the PaymentStatusReport.

Error Handling

No HTTP Response from Electrum (to Payment Initiation Side)

eft on-us debit no http from Electrum

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

Negative Acknowledgement from Electrum (to Payment Initiation Side)

eft on-us debit nack from Electrum

If you receive a negative acknowledgement (NACK, HTTP 5xx or retryable HTTP 4xx) from Electrum in response to the outbound DirectDebit message, then you can retry the transaction up to a set number of times before considering the transaction failed. The 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 (to Payment Initiation Side)

eft on-us debit no psr from Electrum

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

No HTTP Response from the Bank (Payment Initiation Side)

eft on-us debits no http from bank initiating side

If Electrum does not receive an acknowledgement or negative acknowledgement from you in response to a PaymentStatusReport message before the reconciliation window closes then this transaction will be considered a reconciliation exception.

Error with Account Validation

eft on-us debits account validation error

If you receive a PaymentStatusReport containing the status code of RJCT from Electrum, then you can retry the transaction after correcting any discrepancies (e.g., incorrect account details or transaction limits exceeded) or abort the transaction.

No HTTP Response from Bank (Payment Actioning Side)

eft on-us debits no http from bank actioning

If Electrum does not receive an acknowledgement or negative acknowledgement in response to an inbound DirectDebit message before the reconciliation window closes, then the transaction will be considered a reconciliation exception.

Negative Acknowledgement from Bank (Payment Actioning Side)

eft on-us debits nack from bank actioning

If Electrum receives a negative acknowledgement (NACK, HTTP 5xx or retryable HTTP 4xx) in response to an inbound DirectDebit message then Electrum will continue to send the message via a SAF queue. If Electrum does not receive an acknowledgement before the reconciliation window closes, this transaction will be considered a reconciliation exception.

No PaymentStatusReport from Bank (Payment Actioning Side)

eft on-us debits no psr from bank actioning

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

No HTTP Response from Electrum to Bank (Payment Actioning Side)

eft on-us debits no http to bank actioning

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