Use Cases: Electrum as Secondary Store of Proxy Data

Important

These use cases apply where Electrum maintains a mirror of the participant's master account and proxy data.

Proxy registration with the scheme

This applies to all of the below use cases that require a proxy to be registered or deregistered with the scheme.

A proxy identifier can be registered against a specific domain with the scheme. This means that if the scheme operator receives a payment request containing a domainless proxy (i.e. just the proxy identifier and not a domain), it will route the transaction to the beneficiary institution indicated by the registered proxy-domain record.

When registering or deregistering a proxy and its domain with the scheme, the proxy information is contained in the schemeRegistration section of the message payload. The personal identifier and domain are set in the identifier.value and domain fields, respectively.
Copy
Copied
"schemeRegistration": {
  "schema": "ZA_RPP",
  "domain": "aDomain",
  "identifier": {
    "schema": "MOBILE",
    "value": "+27-0821111111"
}

1. Create an account, link a proxy to it, and register it against a specific domain

  1. Your customer requests to create a new account, link a proxy to it, and register it with the scheme.
  2. You create a new account record on your master system and link it to the proxy.
  3. You request Electrum to register the proxy with the scheme operator using the registerCustomerAccountAddIdWithScheme operation.
  4. Electrum forwards the request to the scheme operator.
  5. When a positive response is received from the scheme, Electrum forwards the response to you.
  6. You update your account record to indicate that the proxy is registered with the scheme.
  7. You request Electrum to update the account mirror with the new account, proxy, and domain details using the putCustomerAccount operation.

2. Create an account and link a proxy to it without registering it against a specific domain

  1. Your customer requests to create a new account and link a proxy to it without registering it with the scheme.
  2. You create a new account record on your master system and link it to the proxy.
  3. You request Electrum to update the account mirror with the new account, proxy, and domain details using the putCustomerAccount operation.

3. Create an account without linking a proxy to it

  1. Your customer requests to create a new account without linking a proxy to it.
  2. You create a new account record on your master system with no proxy linked to it.
  3. You request Electrum to update the account mirror with the new account record using the putCustomerAccount operation.

4. Add a proxy to an existing account and register it against a specific domain

  1. Your customer requests to link a proxy to an existing account and register it with the scheme.
  2. You update your existing account record with the proxy information.
  3. You request Electrum to register the proxy with the scheme operator using the registerCustomerAccountAddIdWithScheme operation.
  4. Electrum forwards the request to the scheme operator.
  5. When a positive response is received from the scheme, Electrum forwards the response to you.
  6. You update your account record to indicate that the proxy is registered with the scheme.
  7. You request Electrum to link the existing account record with the new proxy and domain using the addCustomerAccountAdditionalId operation.

5. Add a proxy to an existing account without registering it with the scheme

  1. Your customer requests to link a proxy to an existing account, but not register it with the scheme.
  2. You update your existing account record with the proxy information.
  3. You request Electrum to link the existing account record to the new proxy and domain using the addCustomerAccountAdditionalId operation.

6. Register an existing proxy on an account against a specific domain

  1. Your customer requests to register an existing proxy with the scheme.
  2. You request Electrum to register the proxy with the scheme operator using the registerCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You update your account record to indicate that the proxy is registered with the scheme.
  6. You request Electrum to link the existing account record with the new proxy and domain using the updateCustomerAccountAddId operation.

7. Deregister a proxy-domain link with the scheme

  1. Your customer requests to deregister a proxy with the scheme.
  2. You request Electrum to deregister the proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You update your account record to indicate that the proxy is no longer registered with the scheme.
  6. You request Electrum to update the existing account record using the updateCustomerAccountAddId operation.

8. Register a proxy against a different domain

  1. Your customer requests to reregister a proxy with a different domain.
  2. You request Electrum to deregister the proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You request Electrum to register the proxy against the new domain with the scheme operator using the registerCustomerAccountAddIdWithScheme operation.
  6. Electrum forwards the request to the scheme operator.
  7. When a positive response is received from the scheme, Electrum forwards the response to you.
  8. You update your account record to indicate that the domain is registered with the scheme.
  9. You request Electrum update the existing account record with the new domain using the updateCustomerAccountAddId operation.

9. Change a proxy to be linked to a different account than the current one, within the same domain

  1. Your customer requests to link a proxy to a different account within the same domain.
  2. You remove the link between the proxy and the original account, and create a link between the proxy and the new account.
  3. You request Electrum to remove the link between the proxy and the original account using the deleteCustomerAccountAddId operation.
  4. You request Electrum to link the new account to the proxy using the addCustomerAccountAdditionalId operation.
Note

In this scenario, the new account already exists in your system and the Electrum account mirror. Only the proxy-account links are changed.

10. Change a proxy to link to a different account within a different domain, and reregister the proxy against the new domain

  1. Your customer requests to register a proxy to a different account within a different domain.
  2. You request Electrum to deregister the proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You request Electrum to register the proxy against the new domain with the scheme operator using the registerCustomerAccountAddIdWithScheme operation.
  6. Electrum forwards the request to the scheme operator.
  7. When a positive response is received from the scheme, Electrum forwards the response to you.
  8. You remove the link between the proxy and the original account, and create a link between the proxy and the new account.
  9. You request Electrum to remove the link between the proxy and the original account using the deleteCustomerAccountAddId operation.
  10. You request Electrum to link the new account to the proxy using the addCustomerAccountAdditionalId operation.
Note

In this scenario, the existing proxy is already registered against the original domain.

11. Change a proxy to be linked to a different account and deregister the proxy

  1. Your customer requests to link a proxy to a different account and deregister the proxy from the scheme so that it is no longer linked to any domain.
  2. You request Electrum to deregister the proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You remove the link between the proxy and the original account, and create a link between the proxy and the new account.
  6. You request Electrum to remove the link between the proxy and the original account using the deleteCustomerAccountAddId operation.
  7. You request Electrum to link the new account to the proxy using the addCustomerAccountAdditionalId operation.

12. Remove a proxy from an account and deregister the proxy

  1. Your customer requests to remove a proxy from their account, where the proxy is registered with the scheme.
  2. You request Electrum to deregister the proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You update your records to remove the proxy from the account record.
  6. You request Electrum to remove the proxy from the account using the deleteCustomerAccountAddId operation.

13. Update the proxy that is linked to an account, and register the new proxy

  1. Your customer requests to change the proxy that is linked to their account, where the original proxy is registered with the scheme.
  2. You request Electrum to deregister the original proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You request Electrum to register the new proxy against with the scheme using the registerCustomerAccountAddIdWithScheme operation.
  6. Electrum forwards the request to the scheme operator.
  7. When a positive response is received from the scheme, Electrum forwards the response to you.
  8. You update your account record to reflect the new proxy.
  9. You request Electrum to update the existing account record with the new proxy using the updateCustomerAccountAddId operation.

14. Update the proxy that is linked to an account, and deregister the old proxy

  1. Your customer requests to change the proxy linked to their account, where the original proxy is registered with the scheme, but deregister from the scheme.
  2. You request Electrum to deregister the original proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You update your account record to reflect the new proxy.
  6. You request Electrum to update the existing account record with the new proxy using the updateCustomerAccountAddId operation.

15. Update the account details linked to a proxy

  1. Your customer requests to update the details of an existing account without changing the linked proxy.
  2. You update the account record on your system.
  3. You request Electrum to update the existing record in the account mirror using the putCustomerAccount operation.

16. Delete an account and deregister the proxy

  1. Your customer requests to delete their account.
  2. You request Electrum to deregister the old proxy with the scheme using the deregisterCustomerAccountAddIdWithScheme operation.
  3. Electrum forwards the request to the scheme operator.
  4. When a positive response is received from the scheme, Electrum forwards the response to you.
  5. You remove or deactivate the account along with its proxy information.
  6. You request Electrum to remove the record from the account mirror using the deleteCustomerAccount operation.

17. Delete an account that does not have a registered proxy linked to it

  1. Your customer requests to delete their account.
  2. You remove or deactivate the account.
  3. You request Electrum to remove the record from the account mirror using the deleteCustomerAccount operation.
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.