Confirm a transaction

post

https://api.instantcashworldwide.ae/sandbox/api/v1/transactions/confirm

Confirms the status of the transaction as 'Downloaded', 'Paid' or 'Report Error'.

Only the following transitions can occur when confirming transactions.

Current Status		New Status
F - Read by Receiving Agent	⭢	D - Downloaded
F - Read by Receiving Agent	⭢	Y - Paid
F - Read by Receiving Agent	⭢	X - Exception reported from Agent
D - Downloaded	⭢	X - Exception reported from Agent
D - Downloaded	⭢	Y - Paid

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

reference

string

required

length ≥ 1

This is 9-digit unique ICTC number given to the Sender.

newStatus

string

required

length ≥ 1

[A-Z]{1}

Transaction status to be updated.

remarks

string | null

Additional notes.

Conditional rules:
• Mandatory if new status reported as X (Exception Reported From Agent).

beneficiaryDetails

object

Beneficiary details.

Conditional rules:
Mandatory if deliver mode is 7 (Cash) and new status reported as Y (Paid).

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