Creates a new request

post

https://api.instantcashworldwide.ae/sandbox/api/v1/requests/post-request

Reporting a request regarding Instant Cash transaction that was initiated by Partner Branch or the Partner Head Office or received by Partner Branch or the Partner Head Office.

6 request types are allowed in the request. Use the request code value, e.g. CP

Request types

Code	Description
CP	Request for Call and Pay
NP	Non Payment Complaint
RA	Request for Amendment
RC	Request for Cancelation
SB	Security Block
OR	Other Request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requestType

string

required

length between 2 and 2

Request Type

reference

string | null

This is 9-digit unique ICTC reference number given to the Sender. Request can be posted only about transaction that belongs to the Partner (x-fapi-financial ID).

remarks

string

required

length between 1 and 6000

Description of the issue.

additionalEmails

array of strings | null

Additional email notifications will be sent, in addition to the existing Partner emails, regarding matters related to the request.
If additional emails already exist for Partner, then it will be replaced with new ones.
If Partner wants to delete additional emails - [] (empty list).
If Partner does not want to change additional emails - null.
Additional emails should be separated by comma.

additionalEmails

attachments

array of objects | null

required

Max 4 attachments, up to 512KB each.
Allowed formats: doc, docx, xlsx, pdf, rtf, jpg, jpeg, png, bmp, gif, zip, rar, txt, csv, xml.

attachments*

Headers

x-fapi-financial-id

string

required

^[A-Z]{2}[0-9A-Z]{4}$

This is the agent correspondent id provided to the agent by the IC Operations department. It is used to facilitate API management and auditing.

x-correlation-id

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

This header is used to uniquely identify the HTTP request and to facilitate troubleshooting.

x-idempotency-key

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

Unique request identifier to support idempotency. You may generate (UUID v4) value using the programming language.

Responses

200Success

400Bad Request

500Server Error

503Server Error