API reference
/
Payments API
/
Transfers
/
Query all

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

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

Approve payment

Request

Approve a payment.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
paymentIdinteger(int64)required
Bodyapplication/jsonrequired
quoteIdstring
oldStatestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
newStatestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
messagestring
ratenumber(double)
sellAmountnumber(double)
buyAmountnumber(double)
fundingTxnIdstring
application/json
{
  "quoteId": "string",
  "oldState": "Account_Reserve",
  "newState": "Account_Reserve",
  "message": "string",
  "rate": 0.1,
  "sellAmount": 0.1,
  "buyAmount": 0.1,
  "fundingTxnId": "string"
}

Responses

OK

Body*/*
object

Submit payment batch

Request

Submit multiple payments as a batch.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
senderAccountsArray of objects(AccountSplit)
recipientAccountsArray of objects(AccountSplit)
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "clientRequestId": "string",
  "quoteId": "string",
  "sellCurrency": "string",
  "buyCurrency": "string",
  "dealtCurrency": "string",
  "sellAmount": 0.1,
  "buyAmount": 0.1,
  "sendDate": "string",
  "senderAccountId": "string",
  "recipientId": "string",
  "notes": "string",
  "purpose": "string",
  "subPurpose": "string",
  "fundSource": "string",
  "userId": 0,
  "userName": "string",
  "orgId": 0,
  "orgName": "string",
  "fiId": 0,
  "legalType": "string",
  "type": "string",
  "rate": 0.1,
  "senderAccounts": [
    { … }
  ],
  "recipientAccounts": [
    { … }
  ]
}

Responses

OK

Body*/*
object

Submit payment

Request

Submit a payment.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "clientRequestId": "string",
  "quoteId": "string",
  "sellCurrency": "string",
  "buyCurrency": "string",
  "dealtCurrency": "string",
  "sellAmount": 0.1,
  "buyAmount": 0.1,
  "sendDate": "string",
  "senderAccountId": "string",
  "recipientId": "string",
  "notes": "string",
  "purpose": "string",
  "subPurpose": "string",
  "fundSource": "string",
  "userId": 0,
  "userName": "string",
  "orgId": 0,
  "orgName": "string",
  "fiId": 0,
  "legalType": "string",
  "type": "string",
  "rate": 0.1,
  "paymentId": "string",
  "state": "Account_Reserve",
  "estimatedPayout": 0,
  "failureCode": "string",
  "timeReceived": 0,
  "approver": "string",
  "orderId": "string",
  "orderStatus": "string",
  "tradeIds": [
    "string"
  ],
  "events": [
    { … }
  ],
  "fundingTxnId": "string",
  "payoutTxnId": "string",
  "refundTxnId": "string"
}

Responses

OK

Body*/*
object

Get payment

Request

Get payment by the payment's ID.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
idinteger(int64)required
No request payload

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "clientRequestId": "string",
  "quoteId": "string",
  "sellCurrency": "string",
  "buyCurrency": "string",
  "dealtCurrency": "string",
  "sellAmount": 0.1,
  "buyAmount": 0.1,
  "sendDate": "string",
  "senderAccountId": "string",
  "recipientId": "string",
  "notes": "string",
  "purpose": "string",
  "subPurpose": "string",
  "fundSource": "string",
  "userId": 0,
  "userName": "string",
  "orgId": 0,
  "orgName": "string",
  "fiId": 0,
  "legalType": "string",
  "type": "string",
  "rate": 0.1,
  "paymentId": "string",
  "state": "Account_Reserve",
  "estimatedPayout": 0,
  "failureCode": "string",
  "timeReceived": 0,
  "approver": "string",
  "orderId": "string",
  "orderStatus": "string",
  "tradeIds": [
    "string"
  ],
  "events": [
    { … }
  ],
  "fundingTxnId": "string",
  "payoutTxnId": "string",
  "refundTxnId": "string"
}

Query waiting for approval

Request

Query for all payments that are waiting for approval.

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "clientRequestId": "string",
    "quoteId": "string",
    "sellCurrency": "string",
    "buyCurrency": "string",
    "dealtCurrency": "string",
    "sellAmount": 0.1,
    "buyAmount": 0.1,
    "sendDate": "string",
    "senderAccountId": "string",
    "recipientId": "string",
    "notes": "string",
    "purpose": "string",
    "subPurpose": "string",
    "fundSource": "string",
    "userId": 0,
    "userName": "string",
    "orgId": 0,
    "orgName": "string",
    "fiId": 0,
    "legalType": "string",
    "type": "string",
    "rate": 0.1,
    "paymentId": "string",
    "state": "Account_Reserve",
    "estimatedPayout": 0,
    "failureCode": "string",
    "timeReceived": 0,
    "approver": "string",
    "orderId": "string",
    "orderStatus": "string",
    "tradeIds": [ … ],
    "events": [ … ],
    "fundingTxnId": "string",
    "payoutTxnId": "string",
    "refundTxnId": "string"
  }
]

Query incomplete

Request

Query for all payments that are incomplete.

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "clientRequestId": "string",
    "quoteId": "string",
    "sellCurrency": "string",
    "buyCurrency": "string",
    "dealtCurrency": "string",
    "sellAmount": 0.1,
    "buyAmount": 0.1,
    "sendDate": "string",
    "senderAccountId": "string",
    "recipientId": "string",
    "notes": "string",
    "purpose": "string",
    "subPurpose": "string",
    "fundSource": "string",
    "userId": 0,
    "userName": "string",
    "orgId": 0,
    "orgName": "string",
    "fiId": 0,
    "legalType": "string",
    "type": "string",
    "rate": 0.1,
    "paymentId": "string",
    "state": "Account_Reserve",
    "estimatedPayout": 0,
    "failureCode": "string",
    "timeReceived": 0,
    "approver": "string",
    "orderId": "string",
    "orderStatus": "string",
    "tradeIds": [ … ],
    "events": [ … ],
    "fundingTxnId": "string",
    "payoutTxnId": "string",
    "refundTxnId": "string"
  }
]

Query completed

Request

Query for all payments that are completed.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
No request payload

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "clientRequestId": "string",
    "quoteId": "string",
    "sellCurrency": "string",
    "buyCurrency": "string",
    "dealtCurrency": "string",
    "sellAmount": 0.1,
    "buyAmount": 0.1,
    "sendDate": "string",
    "senderAccountId": "string",
    "recipientId": "string",
    "notes": "string",
    "purpose": "string",
    "subPurpose": "string",
    "fundSource": "string",
    "userId": 0,
    "userName": "string",
    "orgId": 0,
    "orgName": "string",
    "fiId": 0,
    "legalType": "string",
    "type": "string",
    "rate": 0.1,
    "paymentId": "string",
    "state": "Account_Reserve",
    "estimatedPayout": 0,
    "failureCode": "string",
    "timeReceived": 0,
    "approver": "string",
    "orderId": "string",
    "orderStatus": "string",
    "tradeIds": [ … ],
    "events": [ … ],
    "fundingTxnId": "string",
    "payoutTxnId": "string",
    "refundTxnId": "string"
  }
]

Query all

Request

Query for all payments with all statuses.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
No request payload

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "clientRequestId": "string",
    "quoteId": "string",
    "sellCurrency": "string",
    "buyCurrency": "string",
    "dealtCurrency": "string",
    "sellAmount": 0.1,
    "buyAmount": 0.1,
    "sendDate": "string",
    "senderAccountId": "string",
    "recipientId": "string",
    "notes": "string",
    "purpose": "string",
    "subPurpose": "string",
    "fundSource": "string",
    "userId": 0,
    "userName": "string",
    "orgId": 0,
    "orgName": "string",
    "fiId": 0,
    "legalType": "string",
    "type": "string",
    "rate": 0.1,
    "paymentId": "string",
    "state": "Account_Reserve",
    "estimatedPayout": 0,
    "failureCode": "string",
    "timeReceived": 0,
    "approver": "string",
    "orderId": "string",
    "orderStatus": "string",
    "tradeIds": [ … ],
    "events": [ … ],
    "fundingTxnId": "string",
    "payoutTxnId": "string",
    "refundTxnId": "string"
  }
]

Get payment by ID

Request

Get payment by the payment's ID.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
paymentIdstringrequired
No request payload

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
clientRequestIdstring
quoteIdstring
sellCurrencystring
buyCurrencystring
dealtCurrencystring
sellAmountnumber(double)
buyAmountnumber(double)
sendDatestring
senderAccountIdstring
recipientIdstring
notesstring
purposestring
subPurposestring
fundSourcestring
userIdinteger(int64)
userNamestring
orgIdinteger(int64)
orgNamestring
fiIdinteger(int64)
legalTypestring
typestring
ratenumber(double)
paymentIdstring
statestring
Enum"Account_Reserve""Account_Reserve_Completed""Account_Reserve_Reverted""Account_Update_Failed""Account_Updated""AccountConsent_Denied""AccountConsent_Received""AccountConsent_Waiting""Approval_Declined""Approval_Waiting"
estimatedPayoutinteger(int64)
failureCodestring
timeReceivedinteger(int64)
approverstring
orderIdstring
orderStatusstring
tradeIdsArray of strings
eventsArray of objects(PaymentEvent)
fundingTxnIdstring
payoutTxnIdstring
refundTxnIdstring
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "clientRequestId": "string",
  "quoteId": "string",
  "sellCurrency": "string",
  "buyCurrency": "string",
  "dealtCurrency": "string",
  "sellAmount": 0.1,
  "buyAmount": 0.1,
  "sendDate": "string",
  "senderAccountId": "string",
  "recipientId": "string",
  "notes": "string",
  "purpose": "string",
  "subPurpose": "string",
  "fundSource": "string",
  "userId": 0,
  "userName": "string",
  "orgId": 0,
  "orgName": "string",
  "fiId": 0,
  "legalType": "string",
  "type": "string",
  "rate": 0.1,
  "paymentId": "string",
  "state": "Account_Reserve",
  "estimatedPayout": 0,
  "failureCode": "string",
  "timeReceived": 0,
  "approver": "string",
  "orderId": "string",
  "orderStatus": "string",
  "tradeIds": [
    "string"
  ],
  "events": [
    { … }
  ],
  "fundingTxnId": "string",
  "payoutTxnId": "string",
  "refundTxnId": "string"
}