Get RFI Details by Payment Id
RFI is raised when there is a screening hit while performing compliance check. Compliance officer needs additional information to approve the transaction. Additional information is known as RFI (Request for further information)
Definition
URL
GET https://api-test.instarem.com:4803/api/v1/rfi/payment/{payment_id}
Header Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| authorization | Authentication Token | String | Yes |
| content-type | The Content-Type entity header is used to indicate the media type of the resource. Expected value is application/json. | String | Yes |
| X-CLIENT-ID | Unique id for client generated by Nium, Required only in case of partner based model (E.g. 593feb7c7c52bb2357b2df6c). | String | No |
Example Request
- Bash
- Javascript
- C#
curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/rfi/payment/DEVPY10262620" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\
var data = JSON.stringify({})
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("get", "https://api-test.instarem.com:4803/api/v1/rfi/payment/{payment_id}")
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);
var client = new RestClient("https://api-test.instarem.com:4803/api/v1/rfi/payment/{payment_id}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", @"{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Path Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| payment_id | This is the confirmation unique payment ID generated by Nium. | String | Yes |
Example Response
{
"payment_id": "DEVPY10262620",
"rfi_id": "6107ab689faa86004db80208",
"beneficiary": [
{
"rfi_entity_id": "6107abc59faa86004db80213",
"rfi_entity": "DATE_OF_BIRTH",
"comment": "Date of Birth Required",
"status" : "received",
"rfi_type": "DATE",
"rfi_requested_datetime": "2021-08-02T08:24:37.256Z"
},
{
"rfi_entity_id": "6107abc59faa86004db80215",
"rfi_entity": "DRIVING_LICENSE",
"comment": "Driving License is Required",
"status" : "pending",
"rfi_type": "FILE",
"rfi_requested_datetime": "2021-08-02T08:24:37.256Z"
},
{
"rfi_entity_id": "6107abc59faa86004db80219",
"rfi_entity": "NATIONALITY",
"status" : "pending",
"comment": "Proof of Nationality required",
"rfi_type": "TEXT",
"rfi_requested_datetime": "2021-08-02T08:24:37.258Z"
},
{
"rfi_entity_id": "6107abc59faa86004db8021d",
"rfi_entity": "BANK_STATEMENT",
"status" : "pending",
"comment": "Last 6 months bank statement required",
"rfi_type": "FILE",
"rfi_requested_datetime": "2021-08-02T08:24:37.262Z"
},
{
"rfi_entity_id": "6107abc59faa86004db8021b",
"status" : "pending",
"rfi_entity": "ADDRESS",
"comment": "Residentional address proof is required ",
"rfi_type": "TEXT",
"rfi_requested_datetime": "2021-08-02T08:24:37.258Z"
},
{
"rfi_entity_id": "6107abc59faa86004db80217",
"status" : "pending",
"rfi_entity": "FULL_NAME",
"comment": "Full name Required",
"rfi_type": "TEXT",
"rfi_requested_datetime": "2021-08-02T08:24:37.257Z"
}
],
"remitter": [
{
"rfi_entity_id": "6107abc59faa86004db80211",
"status" : "pending",
"rfi_entity": "BANK_STATEMENT",
"comment": "Last 6 months bank statement required",
"rfi_type": "FILE",
"rfi_requested_datetime": "2021-08-02T08:24:37.255Z"
},
{
"rfi_entity_id": "6107abc59faa86004db8020f",
"rfi_entity": "DATE_OF_BIRTH",
"status" : "received",
"comment": "Date of Birth Required",
"rfi_type": "DATE",
"rfi_requested_datetime": "2021-08-02T08:24:37.254Z"
},
{
"rfi_entity_id": "6107abc59faa86004db8020d",
"rfi_entity": "DRIVING_LICENSE",
"status" : "received",
"comment": "Driving License is Required",
"rfi_type": "FILE",
"rfi_requested_datetime": "2021-08-02T08:24:37.250Z"
},
{
"rfi_entity_id": "6107abc59faa86004db8021f",
"rfi_entity": "FULL_NAME",
"status" : "received",
"comment": "Full name Required",
"rfi_type": "TEXT",
"rfi_requested_datetime": "2021-08-02T08:24:37.263Z"
}
]
}
Response Parameters
| Parameter | Description | Type |
|---|---|---|
| payment_id | Payment id generated by Nium | String |
| status | Status of RFI entity (pending, received) | |
| beneficiary[n].rfi_entity_id | Beneficiary Entity Id example "6107abc59faa86004db8020d" | String |
| beneficiary[n].rfi_entity | Beneficiary RFI entity (Please refer to RFI Entity's section in Data Reference for list of values expected in this field). | String |
| beneficiary[n].comment | Requesting comment | String |
| beneficiary[n].rfi_type | RFI type (It should be FILE or TEXT) | String |
| beneficiary[n].rfi_requested_datetime | RFI datetime is a datetime when the RFI is requested | String |
| remitter[n].rfi_entity_id | Remitter Entity Id example "6107abc59faa86004db8020d" | String |
| remitter[n].rfi_entity | Remitter RFI entity(Please refer to RFI Entity's section in Data Reference for list of values expected in this field). | String |
| remitter[n].comment | Requesting comment | String |
| remitter[n].rfi_type | RFI type (It should be FILE or TEXT) | String |
| remitter[n].rfi_requested_datetime | RFI datetime is a datetime when the RFI is requested | String |