API docs by Redocly

Aptic API Gateway - Other accounts (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Other accounts related API for Aptic solutions

Deposit

Get deposit account details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Responses

Response samples

Content type
{
  • "result": {
    },
  • "account": {
    }
}

Update deposit account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Deposit account detail information

creditorReference
string or null

Party reference code.

object (Account)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Creates a new deposit account

Authorizations:
(oauth2apikey)
Request Body schema:

register deposit account information

creditorReference
string or null

Party reference code.

object (DebetAccount)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "account": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Get deposit account transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

query Parameters
PeriodGuid
string

Optional filter by period identifier.

FromDate
string <date-time>

Optionally only show items after date.

ToDate
string <date-time>

Optionally only show items before date.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "transactions": [
    ]
}

Get deposit account action history.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Request body

invoiceNumber
string or null

Optional filter by invoice number.

actionGroupingGuid
string or null

Optional filter by action grouping identifier.

fromDate
string or null <date-time>

Optionally only show items after date.

toDate
string or null <date-time>

Optionally only show items before date.

actionType
integer <int32> (ActionType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Action type.

actionGroup
integer <int32> (ActionGroup)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

Action group.

Responses

Request samples

Content type
{
  • "invoiceNumber": "string",
  • "actionGroupingGuid": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "actionType": 0,
  • "actionGroup": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "histories": [
    ]
}

Get document from history.

Authorizations:
(oauth2apikey)
path Parameters
accountGuid
required
string

The unique GUID of the deposit account

documentGuid
required
string

The identifier for history item.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Closes the deposit account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Closes the deposit account

Authorizations:
(oauth2apikey)
Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Dispurse from account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Disbursement details

amount
number <double>

Amount to disburse

currencyCode
string or null

Currency code

bankAccountClass
integer <int32>

Account class number, corresponding to one of predefined types (Unknown / Plusgiro / Bankgiro / Bank account(Netherlands) / Foreign bank account / Bankgiro(Denmark) / Bankgiro(Norway) / Bankaccount(Norway) / Bankaccount(Sweden) / Bank account(Finland)).

bankAccountNumber
string or null

Receiving bankaccount number

ibanNumber
string or null

IBAN number

paymentReferenceNumber
string or null

Payment reference number

receiverMessage
string or null

Receiver message

ownMessage
string or null

Own message

Responses

Request samples

Content type
{
  • "amount": 0,
  • "currencyCode": "string",
  • "bankAccountClass": 0,
  • "bankAccountNumber": "string",
  • "ibanNumber": "string",
  • "paymentReferenceNumber": "string",
  • "receiverMessage": "string",
  • "ownMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Transfer between accounts

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Transfer details

receivingAccountGuid
string or null

Receiving Account guid

amount
number <double>

Amount to transfer

currencyCode
string or null

Currency code

paymentReferenceNumber
string or null

Payment reference number

sendingAccountMessage
string or null

Sending account message

receivingAccountMessage
string or null

Receiving account message

Responses

Request samples

Content type
{
  • "receivingAccountGuid": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "paymentReferenceNumber": "string",
  • "sendingAccountMessage": "string",
  • "receivingAccountMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Initiate a payment request for payment service provider.

Depending of payment service provider, you might need to pass additional data in the json object.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any or null

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": null
}

Response samples

Content type
{
  • "result": {
    },
  • "completed": true,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

InvestmentAccounts

Get investment account details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Responses

Response samples

Content type
{
  • "result": {
    },
  • "account": {
    }
}

Update investment account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Investment account detail information

creditorReference
string or null

Party reference code.

object (DebetAccount)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "account": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Creates a new investment account

Authorizations:
(oauth2apikey)
Request Body schema:

register investment account information

creditorReference
string or null

Party reference code.

object (DebetAccount)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "account": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Make a bid/invest.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

The requested bid/investment

creditorReference
string or null

Party reference code.

object (AccountLookup)

A lookup for account.

offerCode
string or null

Offer code

amount
number <double>

Bid amount for this request

currencyCode
string or null

Currency code of the bid amount

validUntil
string or null <date-time>

For how long is the bid valid

minRate
number or null <double>

Minimum rate (e.g. interest rate)

maxRate
number or null <double>

Maximum rate (e.g. interest rate)

minAmount
number or null <double>

Minimum amount (e.g. shares or items)

maxAmount
number or null <double>

Maximum amount (e.g. shares or items)

note
string or null

Internal note for this bid

message
string or null

External message

additionalData
any or null

Additional data in a json object

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "accountLookup": {
    },
  • "offerCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "minRate": 0,
  • "maxRate": 0,
  • "minAmount": 0,
  • "maxAmount": 0,
  • "note": "string",
  • "message": "string",
  • "additionalData": null
}

Response samples

Content type
{
  • "result": {
    }
}

Get investment account transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

query Parameters
PeriodGuid
string

Optional filter by period identifier.

FromDate
string <date-time>

Optionally only show items after date.

ToDate
string <date-time>

Optionally only show items before date.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "transactions": [
    ]
}

Get investment account action history.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Request body

invoiceNumber
string or null

Optional filter by invoice number.

actionGroupingGuid
string or null

Optional filter by action grouping identifier.

fromDate
string or null <date-time>

Optionally only show items after date.

toDate
string or null <date-time>

Optionally only show items before date.

actionType
integer <int32> (ActionType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Action type.

actionGroup
integer <int32> (ActionGroup)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

Action group.

Responses

Request samples

Content type
{
  • "invoiceNumber": "string",
  • "actionGroupingGuid": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "actionType": 0,
  • "actionGroup": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "histories": [
    ]
}

Get document from history.

Authorizations:
(oauth2apikey)
path Parameters
accountGuid
required
string

The unique GUID of the investment account

documentGuid
required
string

The identifier for history item.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Closes the investment account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Dispurse from account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Disbursement details

amount
number <double>

Amount to disburse

currencyCode
string or null

Currency code

bankAccountClass
integer <int32>

Account class number, corresponding to one of predefined types (Unknown / Plusgiro / Bankgiro / Bank account(Netherlands) / Foreign bank account / Bankgiro(Denmark) / Bankgiro(Norway) / Bankaccount(Norway) / Bankaccount(Sweden) / Bank account(Finland)).

bankAccountNumber
string or null

Receiving bankaccount number

ibanNumber
string or null

IBAN number

paymentReferenceNumber
string or null

Payment reference number

receiverMessage
string or null

Receiver message

ownMessage
string or null

Own message

Responses

Request samples

Content type
{
  • "amount": 0,
  • "currencyCode": "string",
  • "bankAccountClass": 0,
  • "bankAccountNumber": "string",
  • "ibanNumber": "string",
  • "paymentReferenceNumber": "string",
  • "receiverMessage": "string",
  • "ownMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Transfer between accounts

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Transfer details

receivingAccountGuid
string or null

Receiving Account guid

amount
number <double>

Amount to transfer

currencyCode
string or null

Currency code

paymentReferenceNumber
string or null

Payment reference number

sendingAccountMessage
string or null

Sending account message

receivingAccountMessage
string or null

Receiving account message

Responses

Request samples

Content type
{
  • "receivingAccountGuid": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "paymentReferenceNumber": "string",
  • "sendingAccountMessage": "string",
  • "receivingAccountMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Initiate a payment request for payment service provider.

Depending of payment service provider, you might need to pass additional data in the json object.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the investment account

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any or null

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": null
}

Response samples

Content type
{
  • "result": {
    },
  • "completed": true,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Leasing

Get leasing details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Responses

Response samples

Content type
{
  • "result": {
    },
  • "customerLeasing": [
    ]
}

Update leasing contract

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Request Body schema:

Leasing account detail information

creditorReference
string or null

Party reference code.

object (LeasingAccount)

Customer leasing contract description.

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "leasingAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Creates a new leasing account

Authorizations:
(oauth2apikey)
Request Body schema:

register leasing account information

creditorReference
string or null

Party reference code.

object (LeasingAccount)

Customer leasing contract description.

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "leasingAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Get leasing transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

query Parameters
PeriodGuid
string

Optional filter by period identifier.

FromDate
string <date-time>

Optionally only show items after date.

ToDate
string <date-time>

Optionally only show items before date.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "transactions": [
    ]
}

Get leasing action history.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Request Body schema:

Request body

invoiceNumber
string or null

Optional filter by invoice number.

actionGroupingGuid
string or null

Optional filter by action grouping identifier.

fromDate
string or null <date-time>

Optionally only show items after date.

toDate
string or null <date-time>

Optionally only show items before date.

actionType
integer <int32> (ActionType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Action type.

actionGroup
integer <int32> (ActionGroup)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

Action group.

Responses

Request samples

Content type
{
  • "invoiceNumber": "string",
  • "actionGroupingGuid": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "actionType": 0,
  • "actionGroup": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "histories": [
    ]
}

Gets lease plan details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Responses

Response samples

Content type
{
  • "result": {
    },
  • "loanPaymentPlans": [
    ]
}

Get document from history.

Authorizations:
(oauth2apikey)
path Parameters
accountGuid
required
string

The unique GUID of the leasing contract

documentGuid
required
string

The identifier for history item.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Add a respite to the leasing contract

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

query Parameters
days
integer <int32>

Number of days for the respite

Responses

Response samples

Content type
{
  • "result": {
    }
}

Closes the leasing account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Closes the leasing account

Authorizations:
(oauth2apikey)
Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Add instalment

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Loan identifyer

Request Body schema:

Add instalment information

object (CustomerLookup)

A lookup for customer.

customerAccountReference
string or null

Loan reference number.

creditorReference
string or null

Party reference code.

object (Instalment)

Instalment information

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "customerAccountReference": "string",
  • "creditorReference": "string",
  • "instalment": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Alters instalment

Authorizations:
(oauth2apikey)
Request Body schema:

Alter instalment information

object (CustomerLookup)

A lookup for customer.

loanReferenceNumber
string or null

Loan reference number.

principalAmount
number <double>

Principal amount.

interestAmount
number <double>

Interest amount.

feeAmount
number <double>

Fee amount.

dueDate
string <date-time>

Due date.

billingDate
string or null <date-time>

Letter date/Billing date. The billing date of the payment notification.

letterTriggeredAt
string or null <date-time>

Letter triggered at.

reminderTriggeredAt
string or null <date-time>

Reminder triggered at.

triggerSettlement
boolean

Trigger or not trigger settlement boolean flag. Default value is false.

service
integer <int32> (InstalmentService)
Enum: 0 1 2

Instalment service.

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "loanReferenceNumber": "string",
  • "principalAmount": 0,
  • "interestAmount": 0,
  • "feeAmount": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "billingDate": "2019-08-24T14:15:22Z",
  • "letterTriggeredAt": "2019-08-24T14:15:22Z",
  • "reminderTriggeredAt": "2019-08-24T14:15:22Z",
  • "triggerSettlement": true,
  • "service": 0
}

Response samples

Content type
{
  • "result": {
    }
}

Closes the loan

Authorizations:
(oauth2apikey)
Request Body schema:

Request data

object (CustomerLookup)

A lookup for customer.

loanReferenceNumber
string or null

Loan reference number.

terminationStatus
integer <int32> (TerminationStatus)
Enum: 0 1

Termination status

nextStatusCheck
string or null <date-time>

Next status check date for pre-termination

minAmountBackToNormal
number or null <double>

Minimal amount to be paid to reserver back to normal Loan from (pre)termination status

object (Account)

Account

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "loanReferenceNumber": "string",
  • "terminationStatus": 0,
  • "nextStatusCheck": "2019-08-24T14:15:22Z",
  • "minAmountBackToNormal": 0,
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Requests a pre-termination of the leasing contract

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Request Body schema:

Request data

object (CustomerLookup)

A lookup for customer.

loanReferenceNumber
string or null

Loan reference number.

terminationStatus
integer <int32> (TerminationStatus)
Enum: 0 1

Termination status

nextStatusCheck
string or null <date-time>

Next status check date for pre-termination

minAmountBackToNormal
number or null <double>

Minimal amount to be paid to reserver back to normal Loan from (pre)termination status

object (Account)

Account

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "loanReferenceNumber": "string",
  • "terminationStatus": 0,
  • "nextStatusCheck": "2019-08-24T14:15:22Z",
  • "minAmountBackToNormal": 0,
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Initiate a payment request for payment service provider.

Depending of payment service provider, you might need to pass additional data in the json object.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any or null

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": null
}

Response samples

Content type
{
  • "result": {
    },
  • "completed": true,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

RevolvingCredits

Get revolving credit details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Responses

Response samples

Content type
{
  • "result": {
    },
  • "customerAccount": {
    }
}

Update revolving credit

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Request Body schema:

revolving credit detail information

creditorReference
string or null

Party reference code.

object (Account)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Creates a new revolving credit account

Authorizations:
(oauth2apikey)
Request Body schema:

register CreditAccount information

creditorReference
string or null

Party reference code.

object (Account)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Get revolving credit transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

query Parameters
PeriodGuid
string

Optional filter by period identifier.

FromDate
string <date-time>

Optionally only show items after date.

ToDate
string <date-time>

Optionally only show items before date.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "transactions": [
    ]
}

Get revolving credit action history.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Request Body schema:

Request body

invoiceNumber
string or null

Optional filter by invoice number.

actionGroupingGuid
string or null

Optional filter by action grouping identifier.

fromDate
string or null <date-time>

Optionally only show items after date.

toDate
string or null <date-time>

Optionally only show items before date.

actionType
integer <int32> (ActionType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Action type.

actionGroup
integer <int32> (ActionGroup)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

Action group.

Responses

Request samples

Content type
{
  • "invoiceNumber": "string",
  • "actionGroupingGuid": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "actionType": 0,
  • "actionGroup": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "histories": [
    ]
}

Get document from history.

Authorizations:
(oauth2apikey)
path Parameters
accountGuid
required
string

The unique GUID of the revolving credit

documentGuid
required
string

The identifier for history item.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Add a respite to the revolving credit

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

query Parameters
days
integer <int32>

Number of days for the respite

Responses

Response samples

Content type
{
  • "result": {
    }
}

Closes the revolving credit

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Closes the revolving credit

Authorizations:
(oauth2apikey)
Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Dispurse from account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Request Body schema:

Disbursement details

amount
number <double>

Amount to disburse

currencyCode
string or null

Currency code

bankAccountClass
integer <int32>

Account class number, corresponding to one of predefined types (Unknown / Plusgiro / Bankgiro / Bank account(Netherlands) / Foreign bank account / Bankgiro(Denmark) / Bankgiro(Norway) / Bankaccount(Norway) / Bankaccount(Sweden) / Bank account(Finland)).

bankAccountNumber
string or null

Receiving bankaccount number

ibanNumber
string or null

IBAN number

paymentReferenceNumber
string or null

Payment reference number

receiverMessage
string or null

Receiver message

ownMessage
string or null

Own message

Responses

Request samples

Content type
{
  • "amount": 0,
  • "currencyCode": "string",
  • "bankAccountClass": 0,
  • "bankAccountNumber": "string",
  • "ibanNumber": "string",
  • "paymentReferenceNumber": "string",
  • "receiverMessage": "string",
  • "ownMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Transfer between accounts

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the revolving credit

Request Body schema:

Transfer details

receivingAccountGuid
string or null

Receiving Account guid

amount
number <double>

Amount to transfer

currencyCode
string or null

Currency code

paymentReferenceNumber
string or null

Payment reference number

sendingAccountMessage
string or null

Sending account message

receivingAccountMessage
string or null

Receiving account message

Responses

Request samples

Content type
{
  • "receivingAccountGuid": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "paymentReferenceNumber": "string",
  • "sendingAccountMessage": "string",
  • "receivingAccountMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Closes the revolving credit

Authorizations:
(oauth2apikey)
Request Body schema:

Request data

object (CustomerLookup)

A lookup for customer.

loanReferenceNumber
string or null

Loan reference number.

terminationStatus
integer <int32> (TerminationStatus)
Enum: 0 1

Termination status

nextStatusCheck
string or null <date-time>

Next status check date for pre-termination

minAmountBackToNormal
number or null <double>

Minimal amount to be paid to reserver back to normal Loan from (pre)termination status

object (Account)

Account

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "loanReferenceNumber": "string",
  • "terminationStatus": 0,
  • "nextStatusCheck": "2019-08-24T14:15:22Z",
  • "minAmountBackToNormal": 0,
  • "creditAccount": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Initiate a payment request for payment service provider.

Depending of payment service provider, you might need to pass additional data in the json object.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the deposit account

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any or null

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": null
}

Response samples

Content type
{
  • "result": {
    },
  • "completed": true,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

VirtualAccounts

Get virtual account details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Responses

Response samples

Content type
{
  • "result": {
    },
  • "account": {
    }
}

Update virtual account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Virtual account detail information

creditorReference
string or null

Party reference code.

object (DebetAccount)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "account": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Creates a new virtual account

Authorizations:
(oauth2apikey)
Request Body schema:

register virtual account information

creditorReference
string or null

Party reference code.

object (DebetAccount)

Account

Responses

Request samples

Content type
{
  • "creditorReference": "string",
  • "account": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "impCreditDebtId": 0,
  • "ledgerAccountId": 0,
  • "journalId": 0
}

Request a refresh of virtual account balance and transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Responses

Response samples

Content type
{
  • "result": {
    }
}

Get virtual account transactions.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

query Parameters
PeriodGuid
string

Optional filter by period identifier.

FromDate
string <date-time>

Optionally only show items after date.

ToDate
string <date-time>

Optionally only show items before date.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "transactions": [
    ]
}

Get virtual account action history.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Request body

invoiceNumber
string or null

Optional filter by invoice number.

actionGroupingGuid
string or null

Optional filter by action grouping identifier.

fromDate
string or null <date-time>

Optionally only show items after date.

toDate
string or null <date-time>

Optionally only show items before date.

actionType
integer <int32> (ActionType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Action type.

actionGroup
integer <int32> (ActionGroup)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

Action group.

Responses

Request samples

Content type
{
  • "invoiceNumber": "string",
  • "actionGroupingGuid": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "actionType": 0,
  • "actionGroup": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "histories": [
    ]
}

Get document from history.

Authorizations:
(oauth2apikey)
path Parameters
accountGuid
required
string

The unique GUID of the virtual account

documentGuid
required
string

The identifier for history item.

Responses

Response samples

Content type
{
  • "result": {
    },
  • "fileName": "string",
  • "extension": "string",
  • "data": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Closes the virtual account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Closure On Account Request

object (CustomerLookup)

A lookup for customer.

creditorReference
string or null

Creditor referencenumber

closureCode
string or null

Closure code

Array of objects or null (ClosureTransaction)

Closure transaction

Responses

Request samples

Content type
{
  • "customerLookup": {
    },
  • "creditorReference": "string",
  • "closureCode": "string",
  • "transactions": [
    ]
}

Response samples

Content type
{
  • "result": {
    }
}

Dispurse from account

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Disbursement details

amount
number <double>

Amount to disburse

currencyCode
string or null

Currency code

bankAccountClass
integer <int32>

Account class number, corresponding to one of predefined types (Unknown / Plusgiro / Bankgiro / Bank account(Netherlands) / Foreign bank account / Bankgiro(Denmark) / Bankgiro(Norway) / Bankaccount(Norway) / Bankaccount(Sweden) / Bank account(Finland)).

bankAccountNumber
string or null

Receiving bankaccount number

ibanNumber
string or null

IBAN number

paymentReferenceNumber
string or null

Payment reference number

receiverMessage
string or null

Receiver message

ownMessage
string or null

Own message

Responses

Request samples

Content type
{
  • "amount": 0,
  • "currencyCode": "string",
  • "bankAccountClass": 0,
  • "bankAccountNumber": "string",
  • "ibanNumber": "string",
  • "paymentReferenceNumber": "string",
  • "receiverMessage": "string",
  • "ownMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Transfer between accounts

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Transfer details

receivingAccountGuid
string or null

Receiving Account guid

amount
number <double>

Amount to transfer

currencyCode
string or null

Currency code

paymentReferenceNumber
string or null

Payment reference number

sendingAccountMessage
string or null

Sending account message

receivingAccountMessage
string or null

Receiving account message

Responses

Request samples

Content type
{
  • "receivingAccountGuid": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "paymentReferenceNumber": "string",
  • "sendingAccountMessage": "string",
  • "receivingAccountMessage": "string"
}

Response samples

Content type
{
  • "result": {
    }
}

Initiate a payment request for payment service provider.

Depending of payment service provider, you might need to pass additional data in the json object.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the virtual account

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any or null

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": null
}

Response samples

Content type
{
  • "result": {
    },
  • "completed": true,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }