First API call

Your first API call demonstrates how to submit a transaction check request and retrieve an immediate response on whether the transaction can proceed.

Get your API key

All API requests require authentication with an API key. See Authentication for details.

Example request

Below is an example of a JSON payload for submitting your first request:

{
    "tenantProcessingTimestamp": "2022-02-17T16:13:29.000Z",
    "tenantTransactionId": "Transaction will be blocked because of the country.",
    "accountHoldingParty": "FUNDS_ORIGINATOR",
    "fundsOriginator": {
        "accountNumber": "DE70203343824781776145",
        "holder": "Herbert Dzeko",
        "bankCountry": "DE"
    },
    "fundsBeneficiary": {
        "accountNumber": "BA565601471038781051",
        "holder": "Martin Dzeko",
        "bankCountry": "BA"
    },
    "settledAmount": 199,
    "settledCurrency": "EUR",
    "usage": "Thank you"
}

Try it out here

Request field descriptions

Field	Description
`tenantProcessingTimestamp`	Timestamp when the transaction was processed on the Tenant’s system.
`tenantTransactionId`	Transaction ID assigned by the tenant. Can be any string or number.
`accountHoldingParty`	The party that holds an account with the tenant – i.e., the Customer of your organization. Possible values: `FUNDS_ORIGINATOR` or `FUNDS_BENEFICIARY`.
`fundsOriginator`	Account object from which the funds are transferred (DEBIT).
`fundsOriginator.accountNumber`	IBAN or account number (SWIFT or domestic format).
`fundsOriginator.holder`	Account holder’s full name.
`fundsOriginator.bankCountry`	ISO 3166-1 alpha-2 country code of the originator’s bank.
`fundsBeneficiary`	An account that receives the funds (CREDIT).
`fundsBeneficiary.accountNumber`	IBAN or account number (SWIFT or domestic format).
`fundsBeneficiary.holder`	Account holder’s full name or company name.
`fundsBeneficiary.bankCountry`	ISO 3166-1 alpha-2 country code of the beneficiary’s bank.
`settledAmount`	Amount displayed on the customer’s bank statement (including fees/expenses). See also `initiatedAmount`.
`settledCurrency`	Currency code in ISO 4217 3-letter format (e.g., `EUR`, `USD`).
`usage`	Free text accompanying the transaction (e.g., payment purpose or reference).

Example response

{
   "tenantTransactionId":"Transaction will be blocked because of the country",
   "caseId":"fd6f0f6f-db51-4159-bd6f-d833ffb2e4cf",
   "proceed":true
}

Response field descriptions

Field	Description
`tenantTransactionId`	Transaction ID provided in the reque
`caseId`	Unique UUID assigned to each transaction, regardless of whether it is suspicious or not.
`proceed`	Indicates if the transaction should be processed. `true` → The transaction is valid and may proceed. `false` → The transaction is suspicious and should be blocked.

Field

Description

tenantTransactionId

Transaction ID provided in the reque

caseId

Unique UUID assigned to each transaction, regardless of whether it is suspicious or not.

proceed

Indicates if the transaction should be processed.

true → The transaction is valid and may proceed.
false → The transaction is suspicious and should be blocked.