API reference
/
Payments API
/
Recipients
/
Get all recipients

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

Get all recipients

Request

Returns all recipients created by a user.

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

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
Query
statusstring
Enum"Submitted""Verified""Rejected"
No request payload

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
]
Response
application/json
[
  {
    "id": 0,
    "version": 0,
    "namespace": "string",
    "creationTime": 0,
    "modificationTime": 0,
    "status": "string",
    "recipientId": "string",
    "alias": "string",
    "legalType": "string",
    "currency": "string",
    "email": "string",
    "phoneNumber": "string",
    "state": "Submitted",
    "orgId": 0,
    "userId": 0,
    "fiId": 0,
    "orgName": "string",
    "fiName": "string",
    "userName": "string",
    "address": { … },
    "bankAccountEntity": { … },
    "cryptoEntity": { … }
  }
]

Create recipient

Request

Creates a new recipient.

Request body is recipient with attributes specified below.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Get recipient

Request

Get recipient by ID.

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

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Update recipient

Request

Updates a recipient.

Request body is recipient with attributes specified below.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
idinteger(int64)required
Bodyapplication/jsonrequired
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Delete recipient

Request

Delete a recipient.

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

Responses

OK

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

Approve recipient

Request

Approve a recipient.

Path
fiIdinteger(int64)required
orgIdinteger(int64)required
userNamestringrequired
idinteger(int64)required
Bodyapplication/jsonrequired
property name*stringadditional property
application/json
{
  "property1": "string",
  "property2": "string"
}

Responses

OK

Bodyapplication/json
idinteger(int64)
versioninteger(int64)
namespacestring
creationTimeinteger(int64)
modificationTimeinteger(int64)
statusstring
recipientIdstring
aliasstring
legalTypestring
currencystring
emailstring
phoneNumberstring
statestring
Enum"Submitted""Verified""Rejected"
orgIdinteger(int64)
userIdinteger(int64)
fiIdinteger(int64)
orgNamestring
fiNamestring
userNamestring
addressobject(AddressEntity)
bankAccountEntityobject(BankAccountEntity)
cryptoEntityobject(CryptoEntity)
Response
application/json
{
  "id": 0,
  "version": 0,
  "namespace": "string",
  "creationTime": 0,
  "modificationTime": 0,
  "status": "string",
  "recipientId": "string",
  "alias": "string",
  "legalType": "string",
  "currency": "string",
  "email": "string",
  "phoneNumber": "string",
  "state": "Submitted",
  "orgId": 0,
  "userId": 0,
  "fiId": 0,
  "orgName": "string",
  "fiName": "string",
  "userName": "string",
  "address": {
    "id": 0,
    "version": 0,
    "houseNo": "string",
    "street": "string",
    "line2": "string",
    "locality": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "addressType": "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": {}
  },
  "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"
  }
}

Accounts

Manage the accounts that source and receive transfers.

Operations

Transfers

Submit and approve payments and query payment status.

Operations