Skip to content
API Reference
/
/
Change state of all recei...

Aritma Banking API (v3)

Download OpenAPI description
bankservice-openapi.json
bankservice-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v3/openapi/bankservice-openapi
Open Banking API
https://bankservice.zdata.no
Open Banking API (Dev)
https://bankservicedemo.zdata.no

Account

Operations

AccountGroup

Operations

Balance

Operations

Company

Operations

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Get incoming payments

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

stateinteger(int32)(InpaymentState)required

Receivable state filter

Enum012
Query
accountstring

Account filter (optional)

fromDatestring(date-time)

Time frame limitation

toDatestring(date-time)

Time frame limitation

takeinteger(int32)

Pagination: Max number to return (default 100)

Default 100
skipinteger(int32)

Pagination: Number to skip (default 0)

Default 0
No request payload

Responses

OK

Body
stateinteger(int32)(InpaymentState)required

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
receivablesArray of objects(ReceivableDto)required

Transactions

receivables[].​receivableIdstring(uuid)

Unique reference for receivable

receivables[].​entryIdstring or null(uuid)

Entry id from account statement

receivables[].​entryReferencestring or null

EntryReference

receivables[].​accountNumberstring or null

Deposit account

receivables[].​debtorAccountNumberstring or null

Withdrawal account

receivables[].​debtorNamestring or null

Customer name

receivables[].​debtorAddressstring or null

Customer address

receivables[].​archiveReferencestring or null

Bank reference

receivables[].​structuredReferencestring or null

KID, FIK, OCR (SCOR reference)

receivables[].​descriptionstring or null

Unstructured reference (payment message)

receivables[].​invoiceNumberstring or null

Invoice number

receivables[].​bookingDatestring(date-time)

Processed date

receivables[].​valueDatestring(date-time)

Exchange date

receivables[].​amountnumber(double)

Payment amount or fee amount

receivables[].​currencystring or null

Payment or fee currency type

receivables[].​bookedAmountnumber or null(double)

Booked amount

receivables[].​exchangeRatenumber or null(double)

Exchange rate

receivables[].​accountCurrencystring or null

Currency of bank account;

receivables[].​chargeAmountnumber or null(double)

Charge amount

receivables[].​chargeCurrencystring or null

Charge Currency

receivables[].​typeinteger(int32)(TransactionType)

TransactionType

  • 0 - Payment
  • 1 - Charge
Enum01
receivables[].​bankTransactionCodestring or null

Bank Transaction Codes Domain, Family and Sub-Familiy, dash separated.

receivables[].​errorMessagestring or null

Error message, only exists on error state

totalinteger(int32)required
Response
{
  "State": 0,
  "Receivables": [
    {
      "ReceivableId": "4c017392-1d1b-40eb-a8ae-5efbac5c90a6",
      "EntryId": "86a6ade9-25cb-4e64-a488-1d105aed0919",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2026-03-07T04:42:18.268437+01:00",
      "ValueDate": "2026-03-07T04:42:18.2684383+01:00",
      "Amount": 55,
      "Currency": "NOK",
      "BookedAmount": 65,
      "AccountCurrency": "NOK",
      "ChargeAmount": 10,
      "ChargeCurrency": "NOK",
      "Type": 0,
      "BankTransactionCode": "PMNT-ICDT-DMCT"
    }
  ],
  "Total": 0
}

Get receivables for a given file. Only valid with client credentials flow

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

batchIdstring(uuid)required

Batch id

Query
takeinteger(int32)

Pagination: Max number to return (default 100)

Default 100
skipinteger(int32)

Pagination: Number to skip (default 0)

Default 0
No request payload

Responses

OK

Body
totalCountinteger(int32)
skipinteger or null(int32)
takeinteger or null(int32)
itemsArray of objects or null(ReceivableDto)
Response
{
  "TotalCount": 1,
  "Skip": 0,
  "Take": 10,
  "Items": [
    {
      "ReceivableId": "457c0fae-bfe8-4194-be82-0aa39ccdcf4e",
      "EntryId": "258c317c-0bb5-41f9-a8cd-e3a87005eeb5",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2026-03-07T04:42:18.2690897+01:00",
      "ValueDate": "2026-03-07T04:42:18.269091+01:00",
      "Amount": 55,
      "Currency": "NOK",
      "BookedAmount": 65,
      "AccountCurrency": "NOK",
      "ChargeAmount": 10,
      "ChargeCurrency": "NOK",
      "Type": 0,
      "BankTransactionCode": "PMNT-ICDT-DMCT"
    }
  ]
}

Change state of all receivables in batch.

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

batchIdstring(uuid)required

Batch id

Body

Update model

stateinteger(int32)(InpaymentState)

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
errorMessagestring or null

Error message (used if State is set to Error)

{
  "state": 0,
  "errorMessage": "string"
}

Responses

OK

Update transaction state

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Body

Update model

stateinteger(int32)(InpaymentState)required

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
errorMessagestring or null

Error message (used if State is set to Error)

idstring(uuid)required

Inpayment Id

{
  "State": 2,
  "ErrorMessage": "Something failed",
  "Id": "c868ee14-56cc-4dfd-9b7e-598905f9daae"
}

Responses

Updated states

Response
No content

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations