Here is an example of a JSON payload that we use for our 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"
}
Explanation
Field | Description |
---|---|
{ |
|
"tenantProcessingTimestamp":"2021-02-25T08:29:20.000Z", |
Timestamp when the transaction was processed at the tenant's side. See FAQs for formatting. |
"tenantTransactionId":"Transaction will be blocked because of the country", |
Transaction ID that is assigned by the tenant. It can be any number or string |
"accountHoldingParty":"FUNDS_ORIGINATOR", |
The party that is holding an account with the tenant – the customer of your organisation |
"fundsOriginator":{ |
The Account object from which the funds are getting transferred (DEBIT) |
"accountNumber":"DE48015628788514252474", |
IBAN or account number in Swift or domestic |
"holder":"Herbert Dzeko" |
An account holder (with first and last name) |
}, |
|
"fundsBeneficiary":{ |
An account that benefits from the funds transferred (CREDIT) |
"accountNumber":"BA853285107173401436", |
IBAN or account number in Swift or domestic |
"holder":"Martin Dzeko" |
An account holder (with first and last name) or company |
}, |
|
"settledAmount":199, |
Amount that is shown on the bank statement of the customer - including fees and other expenses. (see initiatedAmount ) for details |
"settledCurrency":"EUR", |
Currency symbol in the 3 digit ISO 4217 notation |
"usage":"Thank you" |
Free text the initiating party sends with the transaction. |
} |
Response
{
"tenantTransactionId":"Transaction will be blocked because of the country",
"caseId":"fd6f0f6f-db51-4159-bd6f-d833ffb2e4cf",
"proceed":true
}
Explanation
Field name | Description |
---|---|
tenantTransactionId |
Transaction ID assigned by the tenant. |
caseId |
The caseID is a UUID that is automatically assigned to each transaction, no matter if the transaction is suspicious or not. |
proceed |
the important part! proceed has two possible values: true - then the transaction is valid and can be processed. false - then the transaction is suspicious and should be rejected. |
Further reading
- Check out our Use Cases Overview to find the requests that fit your organization's needs.