Skip to content

Payments API (v2)

Integral provides modern REST APIs that streamline integration with core banking systems, enabling seamless access to account balances, efficient management of payee lists, and reliable initiation of payment instructions. Our APIs also extend to open banking and other available interfaces, ensuring comprehensive payment workflow fulfilment.

Languages
Servers
Mock server

https://docs.fxinside.net/_mock/payments/

Payments API

http://payment-server/payments/

Quotes

Get executable quotes, indicative rates, and historical prices.

Operations

Request

This returns new quotes for a combination of dealt amount and specified date.

Request body is quote request with attributes specified below.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
Bodyapplication/jsonrequired
sellCurrencystring
buyCurrencystring
dealtCurrencystring
dealtAmountnumber(double)
sendDatestring
application/json
{ "sellCurrency": "string", "buyCurrency": "string", "dealtCurrency": "string", "dealtAmount": 0.1, "sendDate": "string" }

Responses

OK

Bodyapplication/json
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellCurrencyAmountnumber(double)
buyCurrencyAmountnumber(double)
quoteTimestring
quoteValidityinteger(int64)
ratenumber(double)
currencyPairstring
Response
application/json
{ "quoteId": "string", "sellCurrency": "string", "buyCurrency": "string", "dealtCurrency": "string", "sellCurrencyAmount": 0.1, "buyCurrencyAmount": 0.1, "quoteTime": "string", "quoteValidity": 0, "rate": 0.1, "currencyPair": "string" }

Request

Returns the current exchange rate from buyCurrency to given sellCurrency. This is indicative rate only. Used for estimation purposes only.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
sellCurrencystringrequired
buyCurrencystringrequired
No request payload

Responses

OK

Bodyapplication/json
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellCurrencyAmountnumber(double)
buyCurrencyAmountnumber(double)
quoteTimestring
quoteValidityinteger(int64)
ratenumber(double)
currencyPairstring
Response
application/json
{ "quoteId": "string", "sellCurrency": "string", "buyCurrency": "string", "dealtCurrency": "string", "sellCurrencyAmount": 0.1, "buyCurrencyAmount": 0.1, "quoteTime": "string", "quoteValidity": 0, "rate": 0.1, "currencyPair": "string" }

Request

Returns a history of quotes requested by user. The result is limited to 100 records in reverse chronological order.

Query
fiIdstringrequired
orgIdstringrequired
userNamestringrequired
No request payload

Responses

OK

Bodyapplication/jsonArray [
quoteidstring

The ID of the received quote.

]
Response
application/json
[ { "quoteid": "string" } ]

Recipients

Manage transfer recipients.

Operations

Accounts

Manage the accounts that source and receive transfers.

Operations

Transfers

Submit and approve payments and query payment status.

Operations