API reference
/
Payments API
/
Accounts
/
Delete account

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

Get account

Request

Get account by 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
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "accountId": "string",
  "alias": "string",
  "legalType": "string",
  "verified": true,
  "currency": "string",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "bankAccountEntity": {
    "id": 0,
    "version": 0,
    "holderName": "string",
    "accountNumber": "string",
    "ibanNumber": "string",
    "sortCode": "string",
    "ifscCode": "string",
    "routingNumber": "string",
    "accountType": "string",
    "upiId": "string",
    "swiftCode": "string",
    "entityType": "string",
    "bankName": "string",
    "bankCode": "string",
    "branchCode": "string",
    "addressEntity": { … },
    "address": {}
  },
  "addressEntity": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "string"
  },
  "cryptoEntity": {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "currency": "string",
    "cryptoAddress": "string",
    "network": "string",
    "memo": "string",
    "label": "string",
    "note": "string"
  },
  "balances": [
    { … }
  ]
}

Update account

Request

Updates an account.

Request body is account with attributes specified below.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
idinteger(int64)required
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "accountId": "string",
  "alias": "string",
  "legalType": "string",
  "verified": true,
  "currency": "string",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "bankAccountEntity": {
    "id": 0,
    "version": 0,
    "holderName": "string",
    "accountNumber": "string",
    "ibanNumber": "string",
    "sortCode": "string",
    "ifscCode": "string",
    "routingNumber": "string",
    "accountType": "string",
    "upiId": "string",
    "swiftCode": "string",
    "entityType": "string",
    "bankName": "string",
    "bankCode": "string",
    "branchCode": "string",
    "addressEntity": { … },
    "address": {}
  },
  "addressEntity": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "string"
  },
  "cryptoEntity": {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "currency": "string",
    "cryptoAddress": "string",
    "network": "string",
    "memo": "string",
    "label": "string",
    "note": "string"
  },
  "balances": [
    { … }
  ]
}

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "accountId": "string",
  "alias": "string",
  "legalType": "string",
  "verified": true,
  "currency": "string",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "bankAccountEntity": {
    "id": 0,
    "version": 0,
    "holderName": "string",
    "accountNumber": "string",
    "ibanNumber": "string",
    "sortCode": "string",
    "ifscCode": "string",
    "routingNumber": "string",
    "accountType": "string",
    "upiId": "string",
    "swiftCode": "string",
    "entityType": "string",
    "bankName": "string",
    "bankCode": "string",
    "branchCode": "string",
    "addressEntity": { … },
    "address": {}
  },
  "addressEntity": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "string"
  },
  "cryptoEntity": {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "currency": "string",
    "cryptoAddress": "string",
    "network": "string",
    "memo": "string",
    "label": "string",
    "note": "string"
  },
  "balances": [
    { … }
  ]
}

Delete account

Request

Delete an account.

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

Responses

OK

Bodyapplication/json
messagestring
statusCodeinteger(int32)
Response
application/json
{
  "message": "string",
  "statusCode": 0
}

Get all accounts

Request

Returns all accounts created by a user.

The result is limited to 100 records in reverse chronological order.

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "accountId": "string",
    "alias": "string",
    "legalType": "string",
    "verified": true,
    "currency": "string",
    "orgId": 0,
    "userId": 0,
    "fiId": 0,
    "orgName": "string",
    "fiName": "string",
    "userName": "string",
    "bankAccountEntity": { … },
    "addressEntity": { … },
    "cryptoEntity": { … },
    "balances": [ … ]
  }
]

Create account

Request

Creates a new account.

Request body is account with attributes specified below.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "accountId": "string",
  "alias": "string",
  "legalType": "string",
  "verified": true,
  "currency": "string",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "bankAccountEntity": {
    "id": 0,
    "version": 0,
    "holderName": "string",
    "accountNumber": "string",
    "ibanNumber": "string",
    "sortCode": "string",
    "ifscCode": "string",
    "routingNumber": "string",
    "accountType": "string",
    "upiId": "string",
    "swiftCode": "string",
    "entityType": "string",
    "bankName": "string",
    "bankCode": "string",
    "branchCode": "string",
    "addressEntity": { … },
    "address": {}
  },
  "addressEntity": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "string"
  },
  "cryptoEntity": {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "currency": "string",
    "cryptoAddress": "string",
    "network": "string",
    "memo": "string",
    "label": "string",
    "note": "string"
  },
  "balances": [
    { … }
  ]
}

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
accountIdstringrequired
aliasstring
legalTypestring
verifiedboolean
currencystringrequired
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
bankAccountEntityobject(BankAccountEntity)
addressEntityobject(AddressEntity)
cryptoEntityobject(CryptoEntity)
balancesArray of objects(Balance)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "accountId": "string",
  "alias": "string",
  "legalType": "string",
  "verified": true,
  "currency": "string",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "bankAccountEntity": {
    "id": 0,
    "version": 0,
    "holderName": "string",
    "accountNumber": "string",
    "ibanNumber": "string",
    "sortCode": "string",
    "ifscCode": "string",
    "routingNumber": "string",
    "accountType": "string",
    "upiId": "string",
    "swiftCode": "string",
    "entityType": "string",
    "bankName": "string",
    "bankCode": "string",
    "branchCode": "string",
    "addressEntity": { … },
    "address": {}
  },
  "addressEntity": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "string"
  },
  "cryptoEntity": {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "currency": "string",
    "cryptoAddress": "string",
    "network": "string",
    "memo": "string",
    "label": "string",
    "note": "string"
  },
  "balances": [
    { … }
  ]
}

Transfers

Submit and approve payments and query payment status.

Operations