Create a ventaja transaction.

post

https://api.instantcashworldwide.ae/sandbox/api/v3/transactions/initiate

Creates an Instant Cash transaction for billers and services.
This endpoint is used when a business initiates a payment for bill payment services.
Ex: Ventaja

Note: Only Single Window users (Y-Level users) are authorized to access Ventaja Services.

GCC countries

Code	Name
AE	United Arab Emirates
BH	Bahrain
KW	Kuwait
QA	Qatar
OM	Oman
SA	Saudi Arabia

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. (Required)

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

partnerReference

string

required

length ≥ 1

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

payingAgent

string

required

length ≥ 1

Receiving agent code. (Required)

targetCurrency

string | null

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

targetAmount

double | null

The amount of money the recipient will receive.

Conditional rules:
• TargetAmount is required for PhilHealth biller.
• PhilHealth(G01) should be exactly 2400 PHP

sourceCurrency

string | null

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

sourceAmount

double | null

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

Conditional rules:
• SourceAmount can not be passed for PhilHealth billers.

customerPrincAmount

double

required

> 0

The amount collected from customer. (Required)

originatingCountry

string | null

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

Format: ISO-3166 alpha-2 code

destinationCountry

string | null

Destination country. (Required)

Format: ISO-3166 alpha-2 code.

sourceOfFund

string | null

Source of the funds. (Required)

Use the '/types?filter=source-of-funds' endpoint to get a list of allowed types.
• For billers, allowed values: Salary,Business,Savings,Others

otherSourceOfFund

string | null

Provides a textual description explaining the source of funds in detail

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

deliveryMode

int32

required

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

Use the '/receiving-countries' endpoint to get a list of allowed delivery modes per country.
• For billers, should use mode 5

remittancePurpose

int32

Purpose of the remittance. (Required)

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

otherRemittancePurpose

string | null

Additional notes for remittance purpose.

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

remarks

string | null

An additional remittance details. (Optional)

Maximum 150 characters.

pepIdentified

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.

messagePayeeBranch

string | null

Message to Payee agent. (Optional)

Maximum 100 characters.

callBeneficiary

boolean

Determines whether Beneficiary branch should call to Beneficiary.

onBehalfOfAnotherPerson

boolean

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

totalTransactionAmountPerAnnum

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.

transactionsPerAnnum

int32 | null

Expected transactions per annum.

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

remType

string | null

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

remitter

object

required

beneficiary

object

required

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-agent-user-id

string

\w{1,15}

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

x-agent-user-password

string

Password shared by IC Operations department.

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

200OK

400Bad Request

422Unprocessable Entity. If the HTTP response code is 422 and the error code is PendingTransaction, treat the transaction as Pending. Immediately call the GetTransactionDetails API before retrying or reprocessing.

500Internal Server Error

503Service Unavailable