Last updated

Outbound PayShap Success

This section describes the expected message flow and Electrum Console view for an outbound PayShap transaction with proxy resolution.

Note

This is the standard flow of Electrum’s outbound PayShap service offering.

Your bank’s flow might look slightly different if you have implemented additional or bespoke steps based on your business needs.

Outbound PayShap Success Message Flow

Synchronous and Asynchronous Messaging

Electrum’s standard flow makes use of both synchronous messaging (as in the case of the identifier determination step below) and asynchronous messaging.

Synchronous messaging (between Electrum and bank) is most commonly used for identifier determination processing, however, Electrum does support the use of asynchronous messaging for this purpose.

If your bank uses asynchronous messaging during identifier determination, then your standard flow would be slightly different to what is shown below.

Important

For pay-by-account transactions, the proxy resolution step is omitted, and the transaction flow begins where the bank initiates a clearing transaction (step 5).

For request-to-pay-based transactions, the proxy resolution step may be omitted, and the clearing step occurs after the bank customer has received an inbound request from an industry bank requesting that they make a payment.

outbound payshap success flow

  1. A bank customer initiates a PayShap pay-by-proxy payment. You send a synchronous outboundIdentifierDeterminationRequest (IdentifierDetermination schema) to Electrum.

  2. Electrum sends a proxyResolutionRequest to BankservAfrica and BankservAfrica returns an acknowledgement (ACK, HTTP 200).

  3. BankservAfrica sends a proxyResolutionResponse to Electrum, and Electrum acknowledges.

  4. Electrum sends an outboundIdentifierDeterminationReport to you.

  5. Upon successful proxy resolution, you initiate a clearing transaction by sending an outboundCreditTransfer message (CreditTransfer schema) to Electrum. Electrum returns an acknowledgement (ACK, HTTP 202).

  6. Electrum sends a creditTransferRequest to BankservAfrica and BankservAfrica returns an acknowledgement (ACK, HTTP 200).

  7. BankservAfrica sends a paymentStatusReport to Electrum and Electrum returns an acknowledgement (ACK, HTTP 200).

  8. Electrum sends an outboundCreditTransferResponse message (PaymentStatusReport schema) to you and you respond with an acknowledgement (ACK, HTTP 200).

Pay-by-account and request-to-pay transactions

For pay-by-account transactions, the proxy resolution step is omitted, and the transaction flow begins where the bank initiates a clearing transaction (step 5).

For request-to-pay-based transactions, the proxy resolution step may be omitted, and the clearing step occurs after the bank customer has received an inbound request from an industry bank requesting that they make a payment.

What You Should See in the Electrum Console

The Electrum Console view of the transaction should follow the pattern of the message flow. See the diagram below. Note that the messages have been labelled 1-14 for clarity here - you will not see this labelling in the Console. The messages involved are listed below the diagram.

To see the trace of any message, click on the Bank/BankservAfrica box or the associated arrow. The trace will appear below the Console diagram. You can view the message or save the message for troubleshooting purposes.

ecs outbound payshap