API docs by Redocly

Aptic API Gateway - Common (v1.0)

Download OpenAPI specification:Download

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

Misc common and shared API for Aptic solutions

Bankaccounts

Get bank accounts using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get bank account based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
bankaccountGuid
required
string

The unique GUID of thebank account

Responses

Response samples

Content type
{
  • "bankaccountGuid": "string",
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "accountBalance": 0,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string",
  • "links": [
    ]
}

Updates a bank account

Authorizations:
(oauth2apikey)
path Parameters
bankaccountGuid
required
string

Bank account guid

Request Body schema:

Bank account information

bankaccountNo
string or null

Bank account number.

description
string or null

Short description to identifiy the bank account.

bankaccountClass
integer or null <int32>

Bank account class. Can be used in export files to determine layout.

0 = Unknown.

1 = Plusgiro (Sweden).

2 = Bankgiro (Sweden).

3 = Bank account (Netherlands).

4 = Foreign bank account

5 = Bankgiro (Denmark)

7 = Bankgiro (Norway)

8 = Bankaccount (Norway)

9 = Bankaccount(Sweden)

10 = Bank account (Finland)

internalCode
string or null

Internal code of the bank account.

priority
integer or null <int32>

Priority when multiple bank accounts are suitable.

agreementNo
string or null

Agreement number of the bank account.

bankCode
string or null

Code identifying the bank holding the bank account.

bankDescription
string or null

Name or description of the bank holding the bank account.

countryCode
string or null

Country code of the bank holding the bank account.

zipCode
string or null

Postal zip code to the bank holding the bank account.

city
string or null

City where the bank is holding the bank account.

allowPayments
integer or null <int32>

Is the bank account available for payments or nettings?

0 = No

1 = Payments

2 = Nettings

allowDisbursementsFrom
boolean or null

Is it allowed to disburse from the bank account?

allowDisbursementsTo
boolean or null

Is it allowed to disburse to the bank account?

businessAccount
boolean or null

Is this the business account?

thirdPartyRemittance
boolean or null

Is this account used for 3rd party remittences, like from the bailiff?

powerOfAttorney
boolean or null

Do we have a power of attorney agreement on this bank account?

iban
string or null

IBAN number of the bank account.

bic
string or null

BIC code of the bank holding the bank account.

blz
string or null

BLZ number of the bank account.

swift
string or null

Swift number of the bank account.

Responses

Request samples

Content type
{
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a bank account

Authorizations:
(oauth2apikey)
path Parameters
bankaccountGuid
required
string

Bank account guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": 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
{ }

DirectDebitMandates

Get direct debit mandates using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get direct debit mandate based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
directDebitGuid
required
string

The unique GUID of the direct debit mandate

Responses

Response samples

Content type
{
  • "mandateGuid": "string",
  • "directDebitMandateType": 0,
  • "referenceNo": "string",
  • "bankAccountNo": "string",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "validfrom": "2019-08-24T14:15:22Z",
  • "validuntil": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Updates a direct debit mandate

Authorizations:
(oauth2apikey)
path Parameters
directDebitGuid
required
string

Direct debit mandate guid

Request Body schema:

Direct debit mandate information

referenceNo
string or null

Direct debit mandate reference number.

approvedAt
string or null <date-time>

Direct debit date of approval.

signedDate
string or null <date-time>

Direct debit date of signature.

validfrom
string or null <date-time>

Direct debit "valid from" date.

validuntil
string or null <date-time>

Direct debit "valid to" date.

Responses

Request samples

Content type
{
  • "referenceNo": "string",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "validfrom": "2019-08-24T14:15:22Z",
  • "validuntil": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a direct debit

Authorizations:
(oauth2apikey)
path Parameters
directDebitGuid
required
string

Direct debit guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get direct debit events using filters

Authorizations:
(oauth2apikey)
path Parameters
directDebitGuid
required
string

The unique GUID of the direct debit mandate

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Post a direct debit event

Authorizations:
(oauth2apikey)
path Parameters
directDebitGuid
required
string

The unique GUID of the direct debit mandate

Request Body schema:

The direct debit event to post

directDebitEventType
required
integer <int32>

Direct debit event type.

1 = Agreement notice

2 = New agreement

3 = Deleted agreement

4 = Approve agreement

5 = Reject agreement

6 = Payment

7 = Delete payment

8 = Change payment

9 = No event

10 = New agreement

11 = Agreement rejected

12 = Error

13 = Temporarily cancelled

14 = Restart autotransfer

15 = E-agreement

16 = E-agreement, reminder

17 = E-agreement, reminder 2

18 = Import existing agreement

19 = Change payer reference

20 = Message

21 = Repayment

paymentDate
string or null <date-time>

Payment date

transferAmount
number or null <double>

Transfer amount

currencyCode
string or null

Transaction currency

processAt
string or null <date-time>

Process date

paymentReference
string or null

Payment reference

oldPaymentDate
string or null <date-time>

Old payment date

Responses

Request samples

Content type
{
  • "directDebitEventType": 0,
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "transferAmount": 0,
  • "currencyCode": "string",
  • "processAt": "2019-08-24T14:15:22Z",
  • "paymentReference": "string",
  • "oldPaymentDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "directDebitEventType": 0,
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "transferAmount": 0,
  • "currencyCode": "string",
  • "processAt": "2019-08-24T14:15:22Z",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "confirmedAt": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "comment": "string",
  • "paymentReference": "string",
  • "oldPaymentDate": "2019-08-24T14:15:22Z",
  • "referenceNo": "string",
  • "bankAccountNo": "string",
  • "links": [
    ]
}

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
{ }

MarketData

Post a market data

Authorizations:
(oauth2apikey)
Request Body schema:
Array
code
string or null

Market data code

published
string <date-time>

Timestamp

Array of objects or null (MarketDataMaturity)

Maturity value

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "added": 0,
  • "existing": 0,
  • "existingData": [
    ]
}

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
{ }

PerformanceIndicators

Refresh performance indicator data

Authorizations:
(oauth2apikey)
Request Body schema:

Performance indicator data

code
string or null

Code

Responses

Request samples

Content type
{
  • "code": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Refresh performance indicator data

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Performance indicator data

code
string or null

Code

Responses

Request samples

Content type
{
  • "code": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": 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
{ }