Inyett API / Payment Control
Payment Control
Description
Inyett Payment Control receives payment data from ERP, analyzes transactions and creates warnings if a payment deviates, is incorrect, associated with fraud etc.
Datasets
| Name | Description | Endpoint |
| Batches | Create a batch | POST /3/{profileCountry}/payment-control/batches |
| Batches/Delete | Delete a batch | GET /3/{profileCountry}//payment-control/batches/{externalBatchId} |
| warnings | Get warnings for a specific batch | GET /3/{profileCountry}/payment-control/batches/{externalBatchId}/warnings |
Tables
Creates Batches
Description: Use this endpoint to create batches with transactions that you want to be analysed before sending the payments to the bank.
Endpoint: GET /3/{profileCountry}/payment-control/batches
Method: POST
Path Parameters
| Name | Type | Required | Description |
| externalId | string | false | External id for batch |
| debtorAccount | string | true | Sender Account / The senders account number |
| transactions | list of object [] | List of transactions | |
| paymentdate | datetime | false | The date when the transaction needs to be sent to the bank |
| amount | string | true | The amount of the transaction |
| currency | string | true | The currency of the transaction, 3 letters |
| creditorOrgNr | string | false | The organisation number of the Payment receiver |
| ocr | string | false | The OCR number of the transaction |
| verNr | string | false | verification number |
| invoiceNr | string | false | invoice number |
| creditorAccountType | string | true | The account type of the receiver, for example (
BGNR, PGNR, BBAN, IBAN, BANK, BCHQ, CASH) |
| creditorAccount | string | true | The account number to the Payment receiver |
| externalId | string | false | The Id of the transaction |
Respons
|
Name |
Type |
Scope |
Description (EN) |
|
code |
string |
SE/NO |
Code message: 200,404 or 500 |
Delete Batch
Description: Delete an analyzed batch. The batch and its subsets will be hidden from future analysis
Endpoint: GET /3/{profileCountry}/payment-control/batches/{externalBatchId}
Method: DELETE
Path Parameters
| Name | Type | Required | Description |
| externalId | string | True | Country of the company (NO or SE) |
Respons
|
Name |
Type |
Scope |
Description (EN) |
| message | string | SE/NO | Text message if the deletion was successful or not. |
Get warnings for a Batch
Description: Get information of possible warnings for a batch. Here is a dictionary of all our warnings.
Endpoint: GET /3/{profileCountry}/payment-control/batches/{exteranlBatchId}/warnings
Method: GET
Path Parameters
| Name | Type | Required | Description |
| country | string | True | Country of the company (NO or SE) |
| externalBatchId | string | True | Organisationsnummer of the company to Control |
| languageCode | string | False | Only deliver Default value: False |
| appId | string | False | Description values (SV, NO,EN) |
Respons
|
Name |
Type |
Scope |
Description (EN) |
| analyzeStatus | string | SE/NO | Status of the batch |
|
batchUrl |
string | SE/NO | Url to the batch |
| warnings | list [] of object | List of warnings | |
| id | int | The Id of the warning | |
| transactionExternalId | string | The id of the transaction of the warning | |
| type | string | Type of warning | |
| name | string | Name of warning type | |
| description | string | Description of warning type | |
| category | string | Warning category (Payee/Transaction/Person) | |
| warningUrl | string | Url to the warning in Inyett portal |
User Story: Enhancing payment security and accuracy
As a financial manager
I want to utilize the Inyett Payment Control API to automate and secure our payment processes
So that we can minimize the risks associated with incorrect payments, fraud, and other anomalies by detecting them early in the transaction process.
Acceptance Criteria
1. Creating and analyzing payment batches:
- I have a batch of payments ready to be processed,
- POST this batch to /2/{country}/payment-control/batches with all necessary payment details (like amount, currency, debtor account, etc.),
- Then the API will analyze these transactions for any deviations or indicators of fraud before the payments are sent to the bank.
2. Retrieving warnings for specific batches:
- Given a batch has been analyzed,
- Use the GET method on /2/{country}/payment-control/batches/{exteranlBatchId}/warnings,
- Then I will receive a list of any warnings generated during the analysis, allowing me to review and address potential issues before proceeding with the payments.
3. Deleting payment batches:
- Given a batch is no longer required or needs to be corrected,
- When I DELETE the batch via /2/{country}/payment-control/batches/{exteranlBatchId},
- The API will remove the batch, ensuring it and its transactions are excluded from future analysis and processing.
Business Value:
Integration with the Inyett Payment Control API provides significant value by:
- Reducing Financial Risks: Early detection of payment errors and potential fraud, minimizes the risk of financial losses.
- Streamlining Operations: Automating the analysis and vetting process of payments enhances operational efficiency.
- Improving Compliance: Ensures all transactions are scrutinised according to regulatory standards and internal policies.
- Enhancing Trust: Building confidence among stakeholders with transparent and secure financial practices.
By implementing this API, the company can safeguard its financial transactions while optimising payment operations, contributing to overall business resilience and integrity.