Receive Payment

get

https://api.instantcashworldwide.ae/sandbox/api/v1/transactions/receive-payment

Returns the payment details of the outstanding transaction for the provided Instant Cash Transaction Code (ICTC) number.

Once the payment is received by the agent, the transaction is locked, and the status of the transaction is changed to F (Read by Receiving Agent).
Locked means the status of the transaction is changed to F (Read by Receiving Agent)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reference

string | null

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

Conditional rules:
• Either Reference or PartnerReference is mandatory. Both values cannot be passed at a time.

partnerReference

string | null

Unique number sent by Agent system for each transaction.

Conditional rules:
• Either PartnerReference or Reference is mandatory. Both values cannot be passed at a time.

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