Inbound Credits and Debits

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

Successful Inbound Credit or Debit

inbound pay success

Electrum receives a file from BankservAfrica containing a bundle of debit and credit transactions to be processed under the specific EFT payment sub-service.
Electrum determines what type of file a particular payment comes from and decides:

Whether a payment must be processed the same day or on another day.
Whether the payment is a credit (to be processed immediately) or a debit (to be processed later in the day).

Once the transaction is ready to be sent to the you (action date is reached and – in the case of debits – the allowed processing window is reached) Electrum sends either:

An inboundCreditTransfer [request] (/openapi/elpapi-partner/operation/inboundCreditTransfer/) to the /inbound/credit-transfer endpoint, in the case of a credit transaction (CreditTransfer schema; see below), or
An inboundDirectDebit [request] (/openapi/elpapi-partner/operation/inboundDirectDebit/) to the inbound/direct-debit endpoint in the case of a debit transaction (DirectDebit schema; see below.)

The message is sent via an Electrum store-and-forward (SAF) queue which repeats the message until you return a positive response.

CreditTransfer Schema

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre- agreed period.

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '<major units>.<minor units> with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(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.

creditorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

DirectDebit Schema

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

transactionIdentifiers.transactionIdentificationstring<= 35 characters

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(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.

creditorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

You respond with an HTTP status code 202.

Note

Electrum sends these EFT messages via a SAF queue (while not doing so for similar messages processed in RTC or RPP) because of the assumed settlement principle in EFT. Because BankservAfrica assumes approval of the transaction, Electrum will continue sending the request to the bank to ensure the message is delivered and the transaction will be processed.

After you have successfully processed the transaction (debited or credited the relevant account), you send Electrum:

An inboundCreditTransferResponse message to the /inbound/credit-transfer-response endpoint (PaymentStatusReport schema) in the case of a credit payment.
An inboundDirectDebitResponse message to the /inbound/direct-debit-response endpoint (PaymentStatusReport schema) in the case of a debit payment.

PaymentStatusReport Schema

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

transactionIdentifiers.transactionIdentificationstring<= 35 characters

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(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.

creditorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

Electrum returns an HTTP status code of 202 to acknowledge receipt of the PaymentStatusReport.

Note

Electrum will not forward the PaymentStatusReport to BankservAfrica in the case of a successful payment. Here, Electrum simply consumes the PaymentStatusReport, acknowledges it, and updates the correct payment status in the Electrum processing engine.

Error Handling

No Acknowledgment File From Electrum to BankservAfrica

If Electrum does not respond to a file sent from BankservAfrica, BankservAfrica will notify you that a file has been sent. You must notify Electrum. BankservAfrica and Electrum will resolve the issue amongst themselves. BankservAfrica will then resend the file and the transaction will proceed as for a successful transaction.

Note

Electrum must ensure that the resent file is not processed twice.

Negative Acknowledgement from Homing Bank

inbound pay NACK from HB

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

Note

Electrum will continue to send the message via a SAF queue for all HTTP 5xx and 4xx NACKs that are considered transient (i.e., recoverable). If Electrum receives an unretryable HTTP 4xx NACK, then Electrum will stop sending the message and the error will be resolved manually.

No Acknowledgement from Homing Bank

inbound pay no response from HB

If Electrum does not receive an HTTP message from you in response to a sent transaction, then Electrum will continue to send the transaction via a SAF queue. If there is still no response by the time the reconciliation window closes, then the transaction will be considered a reconciliation exception and must be handled as part of the Back Office/reconciliation process.

No PaymentStatusReport from Homing Bank

inbound pay NACK from HB

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

No HTTP Response from Electrum

No http from Electrum

If you send a PaymentStatusReport and do not receive an HTTP ACK or NACK from Electrum, then you can retry the transaction up to a set number of times before the transaction is considered failed. The failed transaction will be considered a reconciliation exception.

Unpaid EFT Transaction

inbound pay unpaid

If Electrum receives a PaymentStatusReport message containing status code RJCT, it means that the payment could not be actioned. Electrum will generate an unpaid transaction and store the transaction in the database. This transaction will be included in the next same-day file with a reason code for why it is an unpaid.

The unpaid transaction will go via BankservAfrica back to the originating bank to be reversed. See the unpaid transaction journey here.

Inbound Credits and Debits

Successful Inbound Credit or Debit

Error Handling

No Acknowledgment File From Electrum to BankservAfrica

Negative Acknowledgement from Homing Bank

No Acknowledgement from Homing Bank

No PaymentStatusReport from Homing Bank

No HTTP Response from Electrum

Unpaid EFT Transaction

Was this page helpful?