Request identifier information

This operation is asynchronous. The outcome of the request is delivered by the inboundIdentifierDeterminationReport operation.

The inbound identifier determination operation can be called to resolve additional information about an identifier, for example to resolve a proxy.

In the context of an inbound payment, Electrum sends an identifier determination to the partner for processing.

Scheme	Applicable	Function Enabled
ZA_EFT	✗	N/A
ZA_RPP	✓	Proxy Resolution - Validate a proxy and return additional information for use in a subsequent credit transfer
ZA_RTC	✗	N/A

Request

header Parameters

traceparent	string (traceparent) ^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]... A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].
tracestate	string (tracestate) ^[A-Za-z0-9=, _\*/@]{0,1024}$ A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

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"

Responses

202

Accepted. RFC9110 - 202

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

405

Method not allowed. RFC9110 - 405

422

Unprocessable content. RFC9110 - 422

429

Too Many Requests. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/identifiers/inbound/identifier-determination

Request samples

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"
}
}

Response samples

application/json

{"detail": "string",
"message": "string",
"schema": "ErrorDetail"
}