API Reference

Create a transaction using an approved quote.

post
https://ic-webapi-test.azurewebsites.net/api/v4/transactions/initiate
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Use the Quote Id received using /api/v1/quote endpoint. (Required)

string | null

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

Before sending a transaction agent should generate a number using the 'transactions/generate-ictc' request.

string | null

Unique number sent by Agent system for each transaction. (Required)

string | null

Receiving agent code. (Required)

string | null

The currency code of the target amount as specified by ISO4217. (Required)

double | null

The amount of money the recipient will receive.

Conditional rules:
• Either TargetAmount or SourceAmount is required. Both values cannot be passed at a time.

string | null

The currency code of the settlement amount as specified by ISO4217. (Required)

double | null

The amount of money the remitter is sent in local currency.

Conditional rules:
• Either TargetAmount or SourceAmount is required. Both values cannot be passed at a time.

double

The amount collected from customer. (Required)

string | null

Originating country from where the remittance is sent. (Required)

Format: ISO-3166 alpha-2 code

string | null

Destination country. (Required)

Format: ISO-3166 alpha-2 code.

string | null

Source of the funds. (Required)

Use the '/types?filter=source-of-funds' endpoint to get a list of allowed types.

string | null

Provides a textual description explaining the source of funds in detail

Conditional rules:
• Mandatory if SourceOfFund is 39 (Others)

int32

Defines the method of remittance to the recipient. (Required)

Use the '/receiving-countries' endpoint to get a list of allowed delivery modes per country.

int32

Purpose of the remittance. (Required)

Use the '/types?filter=remittance-purposes' endpoint to get a list of allowed types.

string | null

Additional notes for remittance purpose.

Conditional rules:
• Mandatory if RemittancePurpose is 23 (Others)

string | null

An additional remittance details. (Optional)

Maximum 150 characters.

boolean

Politically Exposed Person

Specifies whether to check the sender in the PEP list. (Optional)

If true, transaction will go to Compliance block to check if Remitter is PEP.

string | null

Message to Payee agent. (Optional)

Maximum 100 characters.

boolean

Determines whether Beneficiary branch should call to Beneficiary.

boolean

The value indicates that the transaction is being sent on behalf of another person.

double | null

Expected total amount per annum.

Conditional rules:
• It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries.

int32 | null

Expected transactions per annum.

Conditional rules:
• It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries.

string | null

Specifies the type of remittance for the transaction(Individual or Corporate).

remitter
object
beneficiary
object
Headers
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.

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.

string
\w{1,15}

This is the user code provided to the agent by the IC Operations department.

string

Password shared by IC Operations department.

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

Updated 3 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?