Submit RFI Details
This API is used to submit the responses for an RFI raised as per the Get RFI Details by Payment Id.
The API can accept information related to a single RFI entity in a given call. Post submission of the information pertaining to a RFI Entity, the status of the RFI will be Pending and when information against all the RFI Entities are submitted then the status will change to Submitted.
Once information against all the RFI Entity have been submitted that is when the Compliance officer will review the payment instruction. Any change in status of transaction will trigger the payment notification webhook - Payment Status update.
Definition:
URL
POST https://api-test.instarem.com:4803/api/v1/rfi/{rfi_id}
Headers 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 values could be multipart/form-data | 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:
curl --location --request POST 'https://api-test.instarem.com:4803/api/v1/rfi/6107ab689faa86004db80208' \\
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'Content-Type: multipart/form-data' \\
--form 'rfi_entity_id="6107abc59faa86004db80219"' \\
--form 'payment_id="DEVPY10262620"' \\
--form 'comment="Date of birth provided"' \\
--form 'value="10-09-1994"'
Body Parameters:
| Parameter | Description | Type | Required |
|---|---|---|---|
| rfi_entity_id | Unique ID generated by NIUM against the required information. Each information required as part RFI will have its respective rfi_entity_id. (E.g. BANK_STATEMENT: 6107abc59faa86004db80219). | String | Yes |
| payment_id | Unique payment id generated by Nium. | String | Yes |
| comment | Additional information/comments to be provisioned by the Client/Remitter w.r.t the given RFI | String | Yes |
| value | Information (Non File) to be shared by the Client/Remitter w.r.t the given RFI Entity | String | Yes |
| document | Information file submitted by the Client/Remitter w.r.t the given RFI Entity. File formats allowed: ('.xps', '.docx', '.doc', '.xls', '.xlsx','.csv', '.pdf', '.jpg', '.gif', '.jpeg', '.tiff', '.png', '.bmp', '.zip', '.7z', '.rar'). | File | No |
Example Response:
{
"rfi_id": "6107ab689faa86004db80208",
"rfi_status": "Pending"
}
Response Parameters:
| Parameter | Description | Type |
|---|---|---|
| rfi_id | Unique rfi id generated by Nium. | String |
| rfi_status | Pending: When few rfi is yet to be submitted Received: when all rfi is submitted | String |