Step 0: PayShap Inbound Proxy Resolution

Important

This step only applies to the PayShap scheme, and where the receiving participant is not making use of the Electrum account mirror service.

Overview

If you are not using Electrum's account mirror service, then you will be required to perform the necessary proxy functions for all inbound PayShap credit transfer requests.

When Electrum receives a request from the payment scheme to credit one of your customer's account, Electrum will make two requests to your proxy management system:

A request for the account holder name linked to the proxy so that this can be returned to the sender for verification.
A request for the account number linked to the proxy so that this can be used to enrich the credit transfer request before delivery to your core banking system.

These requests are made via the same pair of asynchronous API operations. The implementation of the operations is described below.

Receive Inbound Identifier Request

Receive Request

Electrum sends an inboundIdentifierDetermination request to your API endpoint. The request will conform to the following schema:

Request Body schema: application/json

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 (DeterminationRequest)
schema required	string Value: "IdentifierDeterminationRequest"

application/json

{"messageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"schema": "IdentifierDeterminationRequest",
"request": {"schema": "ZA_RPP_PROXY_IDENTIFIER_DETERMINATION",
"instructedAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"instructingAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"requestor": {"schema": "INSTITUTION_IDENTIFICATION",
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"domain": "ADomain",
"name": "Amazing Bank Inc"
},
"identifier": {"namespace": "AnotherDomain",
"schema": "MOBILE",
"value": "+27-0214620000"
},
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
"verificationIdentification": "e3360de097fe42a195cc53251d0ec839"
},
"supplementaryData": {"customData1": "My custom data 1",
"customData2": "My custom data 2"
}
}

Respond With Success

If you receive the request successfully and are able to submit it for asynchronous processing, then respond with an HTTP 202 status.

Respond With An Error

If you experience an error while handling the request and are unable to submit it for asynchronous processing, then respond with an appropriate error response.

Send Identifier Information Report

Send Outcome

Once you have matched the proxy with the account record on your system, then return the information to Electrum using the inboundIdentifierDeterminationReport operation.

application/json

{"schema": "IdentifierDeterminationResponse",
"messageIdentifiers": {"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"report": {"originalUetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
"originalVerificationIdentification": "1001",
"schema": "ZA_RPP_PROXY_IDENTIFIER_REPORT",
"reportInformation": {"outcome": "SUCCESSFUL",
"transactionLimit": {"value": 3000,
"currency": "ZAR"
},
"accountInformation": {"proxy": {"schema": "MOBILE",
"value": "+27-812456789"
},
"creationDate": "2021-01-01T09:55:45.015708Z"
},
"accountOwner": {"knownAsName": "Shaun",
"legalName": "Shaun John Smith"
}
},
"instructedAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"instructingAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"originalRequestor": {"schema": "INSTITUTION_IDENTIFICATION",
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"domain": "ADomain",
"name": "Amazing Bank Inc"
}
},
"supplementaryData": {"customData1": "My custom data 1",
"customData2": "My custom data 2"
}
}

Receive Acknowledgement

Electrum will respond with an HTTP 202 status if the request can be processed successfully, or an error response if a problem occurs.