Outbound AVS-R
The diagram below shows the message flow between you and Electrum when you initiate an AVS-R transaction to verify account details at a different bank. Note that the steps below describe a synchronous message exchange between your system and Electrum. However, these exchanges are also possible through asynchronous API calls that are available in the API.
- You send Electrum an
outboundSynchronousAccountVerificationmessage (AccountVerificationRequestschema) to verify a customer account held at a different bank.
AccountVerificationRequest Schema
- CreditTransfer
- PaymentStatusReport
- IdentifierSchemeDeregistrationRequest
- IdentifierSchemeDeregistrationResponse
- IdentifierSchemeRegistrationRequest
- IdentifierSchemeRegistrationResponse
- SchemeInquiryRequest
- SchemeInquiryResponse
- IdentifierDeterminationRequest
- IdentifierDeterminationResponse
- AccountUpdateRequest
- AccountAdditionalIdUpdateRequest
- DirectDebit
- PaymentReturn
- RequestToPay
- RequestToPayResponse
- AccountVerificationRequest
- AccountVerificationResponse
- CreditTransferInitiation
- PaymentInitiationStatusReport
- ReservationRequest
- VoidReservationRequest
- PostingRequest
- Receipt
- BaseResponseMessage
- BaseTransactionMessage
Holds a point-to-point unique message identification string as well as a message's creation date time.
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.
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
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
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.
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.
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.
Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.
An explanation of the transaction, e.g. to be printed on the account holder's statement.
Echo data reserved for originator use. Must remain unaltered by the beneficiary.
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).
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. |
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
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.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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).
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.
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).
The identification of a party, either a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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.
Identification of the currency in which the account is held.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Identification of a member of a clearing system.
Name by which an institution is known and which is usually used to identify that institution
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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).
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.
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).
The identification of a party, either a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Identification of a member of a clearing system.
Name by which an institution is known and which is usually used to identify that institution
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
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
Agent(s) between the debtor's agent and the instructing agent.
Specifies the underlying reason for the payment transaction
Electrum passes the message to BankservAfrica and receives a response.
Electrum sends you an
outboundSynchronousAccountVerificationresponse message (AccountVerificationResponseschema) containing the results of the account verification.
AccountVerificationResponse Schema
- CreditTransfer
- PaymentStatusReport
- IdentifierSchemeDeregistrationRequest
- IdentifierSchemeDeregistrationResponse
- IdentifierSchemeRegistrationRequest
- IdentifierSchemeRegistrationResponse
- SchemeInquiryRequest
- SchemeInquiryResponse
- IdentifierDeterminationRequest
- IdentifierDeterminationResponse
- AccountUpdateRequest
- AccountAdditionalIdUpdateRequest
- DirectDebit
- PaymentReturn
- RequestToPay
- RequestToPayResponse
- AccountVerificationRequest
- AccountVerificationResponse
- CreditTransferInitiation
- PaymentInitiationStatusReport
- ReservationRequest
- VoidReservationRequest
- PostingRequest
- Receipt
- BaseResponseMessage
- BaseTransactionMessage
Holds a point-to-point unique message identification string as well as a message's creation date time.
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.
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
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
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.
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.
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.
Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.
An explanation of the transaction, e.g. to be printed on the account holder's statement.
Echo data reserved for originator use. Must remain unaltered by the beneficiary.
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).
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. |
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
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.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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).
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.
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).
The identification of a party, either a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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.
Identification of the currency in which the account is held.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Identification of a member of a clearing system.
Name by which an institution is known and which is usually used to identify that institution
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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).
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.
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).
The identification of a party, either a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Identification of a member of a clearing system.
Name by which an institution is known and which is usually used to identify that institution
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
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
Agent(s) between the debtor's agent and the instructing agent.
Specifies the underlying reason for the payment transaction
Error Handling
The sections below describe what you can expect to see in cases of errors or timeouts at the various entities.
Since AVS-R transactions are non-financial in nature, there is no additional message processing required to undo any potential impact of the original AVS-R transaction.
Error at BankservAfrica
If a functional error is encountered at BankservAfrica (for example, if the destination bank’s system is unavailable and BankservAfrica is unable to deliver the message to them) then Electrum will send a negative AccountVerificationResponse message to you, detailing the reason for the failure.
Timeout at Electrum
If Electrum times out while waiting for a response from BankservAfrica, then Electrum will return a negative AccountVerificationResponse message to you, detailing the timeout error.
No Response from Electrum
If you do not receive an AccountVerificationResponse from Electrum or an error occurs at your system, then the transaction should be considered failed. You may re-attempt the transaction in this case.