Welcome to the ONE API documentation. The guidance provided here is specifically designed to provide you with access to our global payments platform, allowing you to move money seamlessly around the world via our network of global banking partners.
ONE Group was established in 2017 to provide a one-stop financial services solution to pioneers within high-risk industries across its crypto-trading and global multi-bank payments platform.
Supported destinations and currencies The section shows payments in which currencies and in which destinations are available from which types of accounts.
Work with accounts The section describes the types of accounts within ONE, and how to address them while working with the API.
Payment types and transfers The section describes categories of payments and transfers within ONE, and how to choose the best for your task.
How to query Transaction history A scenario for getting transactions history for an account.
How to submit a payment A scenario for sending a payment.
How to submit an internal transfer A scenario for sending an internal transfer.
How to access ONE API The section gives instructions on how to obtain the credentials needed to use the ONE API, and connect our API sandbox.
Authentication This section explains how authentication works with the API, and how to get authentication data.
Veirfying callback signatures This section explains how to verify signatures included with payments' callbacks.
Accounts The section contains a description of API methods for working with accounts.
Payments The section contains a description of API methods for working with payments and transfers.
Transactions The section contains a description of API methods to get information about transactions.
ONE issues accounts in multiple currencies, and enable outbound payments in a large volume of currencies. Full details of supported currencies and payment corridors can be found here .
ONE issues two types of accounts:
GBP Domestic accounts are UK-issued accounts, in GBP only. GBP domestic accounts support payments via Faster Payments, CHAPS and transfers between GBP domestic accounts, either under the ownership of a single customer or other customers.
GBP domestic accounts have the following identifiers:
You can get the ONE Account ID
by:
International accounts are issued in GBP, USD and EUR. ONE international accounts support payments via SWIFT, SEPA (EUR in EEA only) and transfers between accounts, either under the ownership of a single customer or other customers.
ONE international accounts have the following identifiers:
You can get the ONE Account ID
by using the GetAccounts method.
SWIFT
: SWIFT payments exist within the SWIFT international payment network. The SWIFT payment network is used to send and receive international electronic payments in various currencies.
SEPA
: The SEPA is a pan-European network that allows you to send and receive payments in euros EUR between two cross-border bank accounts in the eurozone. The network is spread within the EEA area, Andorra, Monaco, San Marino, Vatican City State, Mayotte, Saint-Pierre-et Miquelon, Guernsey, Jersey and Isle of Man.
Faster Payments
: This can only be used for transactions within the UK for GBP payments. Faster Payments are subject to an upper limit of £250,000. Faster Payments can be completed 7 days a week, 365 days a year, with transactions being completed within 20 minutes.
CHAPS
: This can only be used for transactions within the UK for GBP payments. CHAPS have no upper or lower limit, but
transactions can only be completed between Monday-Friday, 8 am-17:00 GMT and not on bank holidays. Transactions
typically arrive within a day of being processed.
Transfers allow customers to make payments from one domestic account to another domestic account or one international account to another international account. In addition, transfers between international accounts can take advantage of our FX solution to change currencies at a competitive rate.
Transfers between domestic accounts are always like-for-like transactions.
When a payment is initiated, it exists in an initial status Unknown
, the payments service then carries out balance checks against the account (for the transaction value and the associated fee), and a payment transaction will be created, and a payment fee transaction is created.
When a payment is initiated, it exists in an initial status Unknown
, the payments service then carries out
balance checks against the account (for the transaction value and the associated fee), and a payment transaction will be
created, and a payment fee transaction is created.
At this phase, the transaction exists only with the ONE platform, but the platform can be interrogated, and the
transaction will be visible. Two transactions will exist representing the transaction and the fee, they will have
separate IDs, and we also see that the payment is in the Pending
status.
Then the payment goes through other statuses, where it will send the actual transactions to the bank, wait for their
processing, then send the fee, wait for the fee to be processed, and at the very end will see that the payment has
become in the completedPayment
(completedTransfer
for internal transfers) status.
All this time, the API user will pull the API and see that the payment is in some intermediate state, and so on until he sees that the payment is completed.
At the same time, the user can request details from the API for individual transactions in the payment, see how much money was sent and where, and the state of the payment.
IBAN
or accountID
for the required account.accountID
or IBAN
IBAN
or accountID
for the required source account (i.e.
which account will the funds be sent from).paymentID
for the submitted payment.COMPLETE
, REJECTED
).IBAN
or accountID
for the required source account (i.e.
which account will the funds be sent from) and also the accountID for the destination account.We provide a sandbox environment for you to work in and certify ahead of configuring your production API access. The process is as follows:
NOTE: This assumes the customer organisation has passed all the required KYC checks.
You can use the ONE API Sandbox to test your integration to the ONE API.
Access and authorisation mechanisms processes are standard across the sandbox and production environments.
All transactions in the sandbox environment are simulated.
ONE API Authentication requires both OAuth2 authentication and ONE custom authentication.
To obtain this, please:
The next step will be for the customer to configure access as described in the authentication section described Authentication.
The crypto payment gateway facilitates the acceptance of cryptocurrency payments. It also involves submitting transactions, querying information, or accessing various blockchain functionalities.
The Crypto Gateway service is designed to provide a seamless and secure gateway for handling cryptocurrency transactions for your merchant. This service facilitates the integration and management of cryptocurrency payments, ensuring a smooth user and merchant experience.
To initiate your integration successfully, follow these steps:
By completing these steps, you'll establish a strong foundation for a successful integration with ONE.io. Refer to the detailed documentation for each step to ensure a smooth setup process. Our support team is ready to assist you with any issues or questions.
After registering the administrator user record at ONE Platform the invitation email will be send to that email with first login link. Set the user password.
After registering the administrator user record at ONE Platform the invitation email will be send to that email with first login link. Set the user password.
To generate the JWT token use the POST /auth/token
API. Pass in the email and password of your administrator account.
Example:
POST /api/v1/auth/token HTTP/1.1
Host: integration-api.uk-sbx-1.credis.tech
Content-Type: application/json
Content-Length: 65
{
"email": "[email protected]",
"password": "Example"
}
Response will contain the JWT token valid for 1 hour. After token expiration just request the new one.
Encryption keys will be provided by the ONE support team to generate the custom auth payload. The encryption key is 32 bytes long and is encoded in Base64.
Generation of token consists of the following steps:
The API is being invoked on behalf of a specific customer user, therefore user identification is required.
There is a special case with master customers which are allowed to make requests on behalf of their subsidiary customers as configured in the partner auth key.
For such case, the additional subsidiary_customer_id
parameter should be provided in the payload.
Generate JSON as follows:
{
user_id = "c28bd88a-903d-4080-b1f1-0fd0ac0aec25",
email = "[email protected]",
created_date = "2022-05-13T13:45:22Z",
first_name = "Brian",
last_name = "Ferry"
}
Field | Required | Description |
---|---|---|
user_id | true | Customer user's unique ID. API is being used on behalf of given user. |
true | Customer user's email. | |
created_date | true | The date and time the customer user was created. Should be in ISO 8601 format. |
first_name | true | Customer user's first name. |
last_name | true | Customer user's last name. |
subsidiary_customer_id | false | The subsidiary customer's id to make api calls on behalf on. |
Encryption requires utilization of AES-GCM-SIV
cipher: Advanced Encryption Standard (AES) key to be used with the Galois/Counter Mode (GCM) mode of operation.
The encryption goes as follows:
Nonce
.Tag
.UTF-8
bytes. Allocate the same amount of bytes for Ciphertext
.Ciphertext
length, Nonce
length and Tag
length.Nonce
buffer.Ciphertext
buffer, starting at the end of Nonce
.Tag
buffer, starting at the end of Ciphertext
.Refer to example encryption helper class, written in C#:
public class CryptoHelpers
{
private const int TagLength = 16;
private const int NonceLength = 12;
public static byte[] EncryptAesGcm(byte[] key, byte[] plaintext)
{
var aes = new AesGcm(key);
var nonce = RandomNumberGenerator.GetBytes(NonceLength);
var ciphertextBuffer = new byte[plaintext.Length];
var tagBuffer = new byte[TagLength];
try
{
aes.Encrypt(nonce, plaintext, ciphertextBuffer, tagBuffer);
}
catch (CryptographicException ex)
{
throw new CryptoException("Failed to encrypt payload", ex);
}
var resultBuffer = new byte[NonceLength + ciphertextBuffer.Length + TagLength];
nonce.CopyTo(resultBuffer, 0);
ciphertextBuffer.CopyTo(resultBuffer, NonceLength);
tagBuffer.CopyTo(resultBuffer, NonceLength + ciphertextBuffer.Length);
return resultBuffer;
}
}
The resulting ciphertext from previous step is encoded in Base64 encoding.
To make requests put the JWT token into Authorization
header with Bearer
scheme, and custom auth token
into X-Partner-Authorization
header.
For example, request to get all accounts registered to the customer would look like:
GET /api/v1/accounts?sortCode=041377&accountNumber=00000002 HTTP/1.1
Host: integration-api.uk-sbx-1.credis.tech
Authorization: Bearer eyJraWQiOiJfEXAMPLEHDW57H9yVFUWqGPJXe0K01V05Js86nkLngw
X-Partner-Authorization: M90h61elLsEXAMPLEEUqhV4INebu67gw==
ONE will always sign the webhook events it sends to your endpoints. Signature is included in X-Signature
header.
This allows you to verify that the callback originates from ONE.
The secret key to verify signatures will be provided by ONE support team. It is a separate secret, hence not be confused with the key used for generation of authentication token.
ONE generates signatures using a hash-based message authentication code (HMAC
) with SHA-256
hash function.
The signature is in hexadecimal string format. For example for a signature like:
X-Signature: abcdef...
the deserialized signature would have this value:
byte[] signatureBytes = new byte[] { 0xab, 0xcd, 0xef, ... };
Extract the callback's payload bytes.
Example code in C# can be used to calculate the signature for given payload and secret.
public byte[] CalculateSignature(byte[] payload, byte[] secret)
{
using var hmacSha = new HMACSHA256(secret);
var hashBytes = hmacSha.ComputeHash(payload);
return hashBytes;
}
Compare the signature received in callback in X-Signature
header with expected signature.
Get all accounts of the authorized customer. Allows a user to get all customer's accounts or get a specific account by IBAN or a combination of an AccountNumber and SortCode in a bank. Call without any account identifier returns all accounts.
iban | string Example: iban=GB98 MIDL 0700 9312 3456 78 The IBAN of an account to get. When present, AccountNumber and SortCode should be null. |
accountNumber | string Example: accountNumber=43982461 The account number of an account to get. Should be passed together with SortCode only. Can contain up to 8 digits. |
sortCode | string Example: sortCode=017983 The sort code of an account to get. Should be passed together with AccountNumber only. Can contain from 2 to 6 digits. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iban": "string",
- "description": "string",
- "currency": {
- "name": "string",
- "alpha3Code": "string",
- "numericCode": "string",
- "settings": {
- "isAccountCurrency": true,
- "paymentTypes": [
- "internal"
]
}
}, - "balance": 0,
- "availableBalance": 0,
- "pendingFunds": 0,
- "bankId": "30a36e6b-4ce6-409a-8471-fa29e9999b3a",
- "isPrimary": true,
- "status": "unknown"
}
]
Creates accounts for work inside the Great Britain or International one.
New account request body
type required | string (WebAPI.OpenBanking.Models.Requests.v1.Accounts.AccountType) Enum: "international" "domestic" "eurDomestic" |
currency required | string non-empty Enum: "AUD" "EUR" "USD" "GBP" "DKK" "HKD" "NOK" "SEK" "SGD" The currency of an account |
isPrimary | boolean Is the new account should be set as Primary |
{- "type": "domestic",
- "currency": "GBP",
- "isPrimary": false
}
{- "id": "71bb50a6-6801-46f8-bfe0-b380986de291",
- "iban": "GB95BARC20037854846369",
- "accountNumber": "54846369",
- "sortCode": "200378",
- "bic": "CLRBGB22XXX",
- "isPrimary": false
}
Returns information about an account by Account ID in ONE platform.
accountId required | string <uuid> The account id |
{- "id": "93a6096c-d6de-4b95-ad51-16b72f5addd0",
- "iban": "GB09BARC20040196834832",
- "currency": {
- "name": "Pound Sterling",
- "alpha3Code": "GBP",
- "numericCode": "826",
- "settings": {
- "isAccountCurrency": true,
- "paymentTypes": [
- "swift",
- "fasterPayments",
- "chaps"
]
}
}, - "balance": 1.2,
- "availableBalance": 1.2,
- "pendingFunds": 0,
- "bankId": "b8eb7867-fd92-4060-a2a0-9963777d9875",
- "isPrimary": true,
- "status": "active"
}
Exchange the integration customer email and password for access token. Pass this token with Authorization
header when executing any requests to API.
email required | string <email> non-empty Admin email |
password required | string non-empty Admin password |
{- "password": "string"
}
{- "accessToken": "string"
}
ticker required | string The ticker of the crypto asset. |
network | string (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) Enum: "erc20" "trc20" The blockchain network. |
{- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64"
}
ticker | string |
network | string (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) Enum: "erc20" "trc20" |
{- "ticker": "USDT",
- "network": "trc20"
}
{- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64"
}
transactionIdOrHash required | string The transaction id of blockchain transaction hash. |
network | string (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) Enum: "erc20" "trc20" The blockchain network. |
{- "transactionId": "3b06a494-04ad-4155-9390-f165c4104d8c",
- "status": "confirming",
- "transactionHash": "b89a963a1494a6b5c163342a4770e8ca927575ce32e0f199132887140217c60c6",
- "type": "deposit",
- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "amount": 10000,
- "sourceAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64",
- "destinationAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj61",
- "createdDate": "2023-11-16T17:20:11Z"
}
The request without parameters returns the whole list of crypto transactions. But it can be filtered and paginated. All specified criteria will return intersections of data.
createTimeFrom | string <date-time> Example: createTimeFrom=2024-09-16T10:18:41.8788619Z Specifies the beginning of the time range filter for order creation. |
createTimeTo | string <date-time> Example: createTimeTo=2024-09-16T10:18:41.8788619Z Specifies the ending of the time range filter for order creation. |
amountFrom | number <double> Specifies the minimum transaction amount in the asset currency. |
amountTo | number <double> Specifies the maximum transaction amount in the asset currency. |
tickers | Array of strings unique The ticker of the crypto asset. |
networks | Array of strings (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) unique Items Enum: "erc20" "trc20" The blockchain network. |
statuses | Array of strings (WebAPI.OpenBanking.Models.Enums.TransactionStatus) unique Items Enum: "pending" "confirming" "completed" "rejected" Transaction statuses. |
types | Array of strings (WebAPI.OpenBanking.Models.Enums.TransactionType) unique Items Enum: "deposit" "withdrawal" "cryptoTransfer" Transaction types. |
transactionId | string <uuid> The transaction id. |
transactionHash | string The transaction hash. |
sourceAddress | string The sending address from which the transaction is initiated. |
sourceTag | string The source address tag. |
destinationAddress | string The destination address is the receiving address where the funds are intended to be delivered. |
destinationTag | string The destination address tag. |
pageNumber | number <double> [ 0 .. 2147483647 ] |
pageSize | number <double> [ 0 .. 2147483647 ] |
{- "total": 1,
- "items": [
- {
- "transactionId": "3b06a494-04ad-4155-9390-f165c4104d8c",
- "status": "confirming",
- "transactionHash": "b89a963a1494a6b5c163342a4770e8ca927575ce32e0f199132887140217c60c6",
- "type": "deposit",
- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "amount": 10000,
- "sourceAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64",
- "destinationAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj61",
- "createdDate": "2023-11-16T17:20:11Z"
}
]
}
ticker required | string The ticker of the crypto asset. |
network | string (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) Enum: "erc20" "trc20" The blockchain network. |
{- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "balance": 1000
}
[- {
- "id": "a84b6cc6-3021-42b6-bcea-2b040ae681ca",
- "ticker": "USDT",
- "network": "trc20"
}, - {
- "id": "18c58c91-044e-433a-90af-aac12375b994",
- "ticker": "USDT",
- "network": "erc20"
}, - {
- "id": "5683d2ca-4dd5-40a3-8e49-24165a304796",
- "ticker": "BTC"
}
]
organisationId | string <uuid> The Organisation Id. Applicable only for Master Organisations. Use this parameter to query Subsidiary details. |
{- "organisationId": "71b630d6-986e-4394-8fec-27228a1e877d",
- "organisationName": "ONE Limited",
- "balances": [
- {
- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "balance": 1000
}, - {
- "asset": {
- "id": "dc9d46fd-5fd0-4e34-968c-77cb08a6bca7",
- "ticker": "USDT",
- "network": "erc20"
}, - "balance": 100
}
]
}
address required | string The asset wallet deposit address. |
tag | string The differentiator for an asset deposit address with tag/memo support, such as XRP. |
{- "balances": [
- {
- "asset": {
- "id": "3b06a494-04ad-4155-9390-f165c4104d7c",
- "ticker": "USDT",
- "network": "trc20"
}, - "balance": 1000
}, - {
- "asset": {
- "id": "dc9d46fd-5fd0-4e34-968c-77cb08a6bca7",
- "ticker": "USDT",
- "network": "erc20"
}, - "balance": 100
}
]
}
address | string The withdrawal address. |
ticker | string The ticker of the crypto asset. Available values: BTC, ETH, USDT, XRP. |
network | string (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) Enum: "erc20" "trc20" |
tag | string Nullable The differentiator for an asset deposit address with tag/memo support, such as XRP. |
{- "address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64",
- "ticker": "USDT",
- "network": "trc20"
}
{- "address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64",
- "status": "pending",
- "asset": {
- "id": "df8e8f85-e324-401a-b776-891d79beb797",
- "ticker": "USDT",
- "network": "trc20"
}
}
tickers | Array of strings unique Nullable The ticker of the crypto asset. |
networks | Array of strings (WebAPI.OpenBanking.Models.Enums.BlockchainNetwork) unique Nullable Items Enum: "erc20" "trc20" The blockchain network. |
statuses | Array of strings (WebAPI.OpenBanking.Models.Enums.WithdrawalAddressStatus) unique Nullable Items Enum: "pending" "active" "inactive" Withdrawal address statuses. |
pageNumber | number <double> [ 0 .. 2147483647 ] Nullable |
pageSize | number <double> [ 0 .. 2147483647 ] Nullable |
{- "tickers": [
- "string"
], - "networks": [
- "erc20"
], - "statuses": [
- "pending"
], - "pageNumber": 0,
- "pageSize": 0
}
{- "total": 1,
- "items": [
- {
- "address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj64",
- "status": "pending",
- "asset": {
- "id": "df8e8f85-e324-401a-b776-891d79beb797",
- "ticker": "USDT",
- "network": "trc20"
}
}
]
}
currencyFrom required | string Enum: "AUD" "CHF" "EUR" "USD" "GBP" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" Example: currencyFrom=GBP The base currency to get estimated exchange rate for |
currencyTo required | string Enum: "ALL" "DZD" "ARS" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "ISK" "INR" "IDR" "IRR" "IQD" "JMD" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NIO" "NGN" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RWF" "SHP" "SAR" "SCR" "SLL" "VND" "SOS" "SSP" "SZL" "SYP" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "TZS" "UYU" "UZS" "WST" "YER" "TWD" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "VEF" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "XAF" "XCD" "XOF" "XPF" "XDR" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "MXV" "UAH" "GEL" "BOV" "BRL" "CLF" "XSU" "USN" "ILS" "RUB" "TRY" "NZD" "ZAR" "CZK" "HUF" "PLN" "THB" "AUD" "CHF" "EUR" "USD" "GBP" "JPY" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" Example: currencyTo=USD The target currency to get estimated exchange rate for |
{- "rate": 1.15,
- "asOfTime": "2022-10-10T10:10:10Z",
- "isStale": true
}
Get organisation. Allows a user to get info about the organisation and its subsidiaries.
{- "id": "71b630d6-986e-4394-8fec-27228a1e877d",
- "organisation": "My master organisation",
- "isMasterCustomer": true,
- "subsidiaries": [
- {
- "id": "6607a10f-f1f2-4c66-b837-515091730223",
- "organisation": "Subsidiary organisation 1",
- "isMasterCustomerAccessAllowed": true
}, - {
- "id": "b3b4725f-5eac-4348-88f8-32c18c8e85e5",
- "organisation": "Subsidiary organisation 2",
- "isMasterCustomerAccessAllowed": false
}
]
}
{- "id": "f413080c-9a7a-421b-93fb-c8ba72b6c6c8",
- "state": "completed",
- "paymentTransaction": {
- "id": "8a5cb01e-1cb3-4182-8b7a-3236c8f715ba",
- "iban": "LI68088110103878K050G",
- "bic": "BFRILI22XXX",
- "accountCurrency": "GBP",
- "createdDate": "2022-10-10T00:00:00",
- "sentAmount": -2,
- "deductedAmount": -1.46,
- "debitCredit": "debit",
- "reference": "ee0dd4c6-8dde-4eb0-99cd-6743f9b802f3",
- "type": "SWIFT",
- "exchangeRate": 0.7314,
- "estimatedExchangeRate": 0.7257,
- "transactionNumber": "4199942",
- "currency": "USD",
- "recipientSender": {
- "iban": "NL17ABNA6737738109",
- "name": "Martin"
}
}, - "feeTransaction": {
- "id": "994c3c22-9634-473a-b831-6d0bc014ba1b",
- "iban": "LI68088110103878K050G",
- "bic": "BFRILI22XXX",
- "accountCurrency": "GBP",
- "createdDate": "2022-10-10T01:01:01",
- "sentAmount": -0.02,
- "deductedAmount": -0.02,
- "debitCredit": "debit",
- "reference": "SwiftPayment Fee",
- "type": "SWIFT Fee",
- "transactionNumber": "4199943",
- "currency": "GBP",
- "recipientSender": {
- "iban": "GB76BARC20031824219747",
- "name": "Fee account"
}
}
}
New SWIFT payment body
accountId required | string <uuid> The Id of an account in ONE database |
currency required | string non-empty Enum: "ALL" "DZD" "ARS" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "ISK" "INR" "IDR" "IRR" "IQD" "JMD" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NIO" "NGN" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RWF" "SHP" "SAR" "SCR" "SLL" "VND" "SOS" "SSP" "SZL" "SYP" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "TZS" "UYU" "UZS" "WST" "YER" "TWD" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "VEF" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "XAF" "XCD" "XOF" "XPF" "XDR" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "MXV" "UAH" "GEL" "BOV" "BRL" "CLF" "XSU" "USN" "ILS" "RUB" "TRY" "NZD" "ZAR" "CZK" "HUF" "PLN" "THB" "AUD" "CHF" "EUR" "USD" "GBP" "JPY" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" The currency code |
amount required | number <double> [ 0.01 .. 999999999999.99 ] The payment amount |
description | string Nullable The payment description |
name required | string [ 0 .. 35 ] characters The external account name |
iban | string [ 0 .. 34 ] characters Nullable The IBAN to transfer to |
accountNumber | string [ 0 .. 30 ] characters Nullable The account number |
bic | string [ 0 .. 11 ] characters Nullable The BIC |
aba | string [ 0 .. 9 ] characters Nullable The identification code of the beneficiary. Applies to US beneficiaries only. |
address required | string [ 0 .. 70 ] characters The address |
postalcode required | string [ 0 .. 11 ] characters The postal code |
city required | string [ 0 .. 70 ] characters The City |
country required | string non-empty Enum: "XXK" "ARE" "BDI" "BFA" "BGR" "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BEL" "BEN" "BES" "BGD" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" The Country code |
shouldChargeCorrespondentFee | boolean Is the correspondent fee should be charged |
{- "accountId": "93a6096c-d6de-4b95-ad51-16b72f5addd0",
- "currency": "GBP",
- "amount": 5000.5,
- "description": "This is a test payment",
- "name": "Martin",
- "iban": "GB09BARC20040196834832",
- "address": "52 Park Road",
- "postalcode": "SW71 9NV",
- "city": "London",
- "country": "GBR",
- "shouldChargeCorrespondentFee": false
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
New SEPA payment body
accountId required | string <uuid> The Id of an account in ONE database |
currency required | string non-empty Enum: "ALL" "DZD" "ARS" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "ISK" "INR" "IDR" "IRR" "IQD" "JMD" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NIO" "NGN" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RWF" "SHP" "SAR" "SCR" "SLL" "VND" "SOS" "SSP" "SZL" "SYP" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "TZS" "UYU" "UZS" "WST" "YER" "TWD" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "VEF" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "XAF" "XCD" "XOF" "XPF" "XDR" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "MXV" "UAH" "GEL" "BOV" "BRL" "CLF" "XSU" "USN" "ILS" "RUB" "TRY" "NZD" "ZAR" "CZK" "HUF" "PLN" "THB" "AUD" "CHF" "EUR" "USD" "GBP" "JPY" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" The currency code |
amount required | number <double> [ 0.01 .. 999999999999.99 ] The payment amount |
description | string Nullable The payment description |
name required | string [ 0 .. 35 ] characters The external account name |
iban required | string [ 0 .. 34 ] characters The IBAN to transfer to |
address | string [ 0 .. 70 ] characters Nullable The address |
city | string [ 0 .. 70 ] characters Nullable The City |
postalcode | string [ 0 .. 11 ] characters Nullable The postal code |
country required | string non-empty Enum: "XXK" "ARE" "BDI" "BFA" "BGR" "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BEL" "BEN" "BES" "BGD" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" The Country code |
{- "accountId": "93a6096c-d6de-4b95-ad51-16b72f5addd0",
- "currency": "GBP",
- "amount": 5000.5,
- "description": "This is a test payment",
- "name": "Martin",
- "iban": "GB09BARC20040196834832",
- "address": "52 Park Road",
- "city": "London",
- "postalcode": "SW71 9NV",
- "country": "GBR"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
Creates the CHAPS payment that can be executed only between accounts inside GB.
New CHAPS payment body
accountId required | string <uuid> The Id of an account in ONE database |
currency required | string non-empty Value: "GBP" The currency code |
amount required | number <double> The payment amount |
description | string Nullable The payment description |
name required | string [ 0 .. 35 ] characters The external account name |
iban | string [ 0 .. 34 ] characters Nullable The IBAN to transfer to |
accountNumber | string [ 0 .. 30 ] characters Nullable The account number |
sortCode | string [ 0 .. 6 ] characters Nullable The sort code |
{- "accountId": "93a6096c-d6de-4b95-ad51-16b72f5addd0",
- "currency": "GBP",
- "amount": 5000.5,
- "description": "This is a test payment",
- "name": "Martin",
- "iban": "GB09BARC20040196834832"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
Creates a Faster payment (FPS), that can be executed only between accounts inside GB. Upper limit for FPS is £250,000.
New FPS payment body
accountId required | string <uuid> The Id of an account in ONE database |
currency required | string non-empty Value: "GBP" The currency code |
amount required | number <double> [ 0.01 .. 1000000 ] The payment amount |
description | string The payment description |
name required | string [ 0 .. 35 ] characters The external account name |
iban | string [ 0 .. 34 ] characters Nullable The IBAN to transfer to |
accountNumber | string [ 0 .. 30 ] characters Nullable The account number |
sortCode | string [ 0 .. 6 ] characters Nullable The sort code |
{- "accountId": "93a6096c-d6de-4b95-ad51-16b72f5addd0",
- "currency": "GBP",
- "amount": 149.95,
- "description": "This is a test payment",
- "name": "Martin",
- "iban": "GB09BARC20040196834832"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
New internal transfer body
fromAccountId required | string <uuid> The Id of an account to transfer from |
toAccountId required | string <uuid> The Id of an account to transfer to |
amount required | number <double> [ 0.01 .. 999999999999.99 ] The amount to transfer |
description required | string non-empty The transfer description |
{- "fromAccountId": "a38ddc42-6992-4c31-8f8a-632e86d309bb",
- "toAccountId": "84c92b9d-b9c9-443e-8b1f-7b6ba0107d27",
- "amount": 5000.5,
- "description": "This is a test internal transfer"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
TODO
New internal payment body
fromAccountId required | string <uuid> The Id of an account to transfer from |
iban | string Nullable The IBAN of recipient's account |
accountNumber | string Nullable The Account Number of recipient's account |
sortCode | string Nullable The Sort Code of recipient's account |
amount required | number <double> [ 0.01 .. 999999999999.99 ] The amount to transfer |
description required | string non-empty The transfer description |
{- "fromAccountId": "a38ddc42-6992-4c31-8f8a-632e86d309bb",
- "iban": "NL22INGB7762494464",
- "amount": 49.95,
- "description": "This is a test internal payment"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{- "timestamp": "2022-10-18T09:35:47Z",
- "type": "payment.state-changed",
- "payload": {
- "paymentId": "f9e3c728-4c46-4c75-a070-95aa6b31915c",
- "type": "sepa",
- "paymentReference": "Invoice 84354631",
- "isInboundPayment": false,
- "amount": 49.95,
- "currency": "USD",
- "debitor": {
- "accountId": "8a042a4e-4666-4015-a380-38ed42088ee6",
- "description": "Current account",
- "iban": "LI8008800576446678915",
- "bankAccountNumber": "46678915",
- "currency": "EUR"
}, - "creditor": {
- "description": "HAPPY VALLEY FINANCIAL SERVS LTD",
- "iban": "FR7312739000509976544662O79"
}, - "state": "completedPayment"
}
}
transactionId required | string <uuid> The transaction id |
{- "status": "completedPayment",
- "id": "8a5cb01e-1cb3-4182-8b7a-3236c8f715ba",
- "iban": "LI68088110103878K050G",
- "bic": "BFRILI22XXX",
- "accountCurrency": "GBP",
- "createdDate": "2022-10-10T00:00:00",
- "sentAmount": -2,
- "deductedAmount": -1.46,
- "debitCredit": "debit",
- "reference": "ee0dd4c6-8dde-4eb0-99cd-6743f9b802f3",
- "type": "SWIFT",
- "exchangeRate": 0.7314,
- "estimatedExchangeRate": 0.7257,
- "transactionNumber": "4199942",
- "currency": "USD",
- "recipientSender": {
- "iban": "NL17ABNA6737738109",
- "name": "Martin"
}
}
Get transactions. Allows a user to get filtered and paginated transactions
ibans | Array of strings unique Accounts' IBANs |
accountNumbers | Array of strings unique Accounts' account numbers |
sortCodes | Array of strings unique Accounts' sort codes |
bics | Array of strings unique Accounts' BICs |
accountCurrencies | Array of strings unique Items Enum: "AUD" "CHF" "EUR" "USD" "GBP" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" Accounts' currencies |
createdDateFrom | string <date-time> Example: createdDateFrom=2024-09-16T10:18:41.8788619Z Transaction's min created date |
createdDateTo | string <date-time> Example: createdDateTo=2024-09-16T10:18:41.8788619Z Transaction's max created date |
sentAmountFrom | number <double> Transaction's min sent amount |
sentAmountTo | number <double> Transaction's max sent amount |
deductedAmountFrom | number <double> Transaction's min deducted amount |
deductedAmountTo | number <double> Transaction's max deducted amount |
transactionCurrencies | Array of strings unique Items Enum: "ALL" "DZD" "ARS" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "ISK" "INR" "IDR" "IRR" "IQD" "JMD" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NIO" "NGN" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RWF" "SHP" "SAR" "SCR" "SLL" "VND" "SOS" "SSP" "SZL" "SYP" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "TZS" "UYU" "UZS" "WST" "YER" "TWD" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "VEF" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "XAF" "XCD" "XOF" "XPF" "XDR" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "MXV" "UAH" "GEL" "BOV" "BRL" "CLF" "XSU" "USN" "ILS" "RUB" "TRY" "NZD" "ZAR" "CZK" "HUF" "PLN" "THB" "AUD" "CHF" "EUR" "USD" "GBP" "JPY" "CAD" "DKK" "HKD" "NOK" "SEK" "SGD" Transactions' currencies |
statuses | Array of strings (Data.Entities.Payments.Enums.LogicalTransactionState) unique Items Enum: "unknown" "pendingOrganizationApproval" "pendingComplianceApproval" "rejectedByOrganization" "rejectedByCompliance" "rejectedByBank" "completedIncomingTransaction" "completedTransfer" "completedPayment" "pending" "completed" "rejected" "expired" "awaitingFunds" "unexpected" Transactions' statuses |
types | Array of strings (Data.Entities.Payments.Enums.LogicalTransactionType) unique Items Enum: "sepa" "sepaFee" "swift" "swiftFee" "swiftFeeCorrespondent" "swiftFeeCorrespondentUsd" "internal" "annualFee" "activeIbansFee" "adHocFee" "fasterPayments" "fasterPaymentsFee" "chaps" "chapsFee" "inbound" "inboundFee" "directDebit" "directCredit" "basicInbound" "crypto" "other" Transactions' types |
reference | string Transaction's reference |
estimatedExchangeRateFrom | number <double> Transaction's min estimated exchange rate |
estimatedExchangeRateTo | number <double> Transaction's max estimated exchange rate |
exchangeRateFrom | number <double> Transaction's min exchange rate |
exchangeRateTo | number <double> Transaction's max exchange rate |
transactionNumber | string Transaction's transaction number |
recipientSenderFilter.name | string Recipient or sender name |
recipientSenderFilter.iban | string Recipient or sender IBAN |
recipientSenderFilter.accountNumber | string Recipient or sender account number |
recipientSenderFilter.bic | string Recipient or sender BIC |
recipientSenderFilter.sortCode | string Recipient or sender sort code. Must be from 2 up to 6 digits. |
pageNumber | integer <int32> [ 1 .. 2147483647 ] Page number |
pageSize | integer <int32> [ 1 .. 2147483647 ] Page size |
includeSubsidiariesTransactions | boolean If true then all subsidiaries transactions will be returned along with master transactions |
{- "total": 0,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iban": "ES79 2100 0813 6101 2345 6789",
- "accountNumber": "12345674",
- "sortCode": "017983",
- "bic": "string",
- "accountCurrency": "EUR",
- "createdDate": "2024-09-16T10:18:41.8788619",
- "sentAmount": 0,
- "deductedAmount": 0,
- "debitCredit": "debit",
- "reference": "string",
- "type": "string",
- "exchangeRate": 0,
- "estimatedExchangeRate": 0,
- "transactionNumber": "string",
- "currency": "string",
- "recipientSender": {
- "iban": "ES79 2100 0813 6101 2345 6789",
- "name": "string",
- "bic": "string",
- "sortCode": "017983",
- "accountNumber": "12345674",
- "aba": "123456789"
}, - "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
- "status": "unknown"
}
]
}