Initialization

Generates the participant's A, X and E keys locally as an asynchronous job.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/initialization/keys

key (query)

Generates the participant's A, X and E keys locally as an asynchronous job. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Generates the participant's A, X and E keys locally as an asynchronous job. › Headers

X-API-KEY

string · required

The x-api-key header value.

Generates the participant's A, X and E keys locally as an asynchronous job. › Request Body

businessdev.blebics.Contracts.Requests.GenerateKeysRequest

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

signatureVersion

businessdev.blebics.Contracts.Enums.EbicsSignatureVersion · enum

Enum values:

A005

A006

keyPassword

string

signatureKeyLength

integer · int32

protocolKeyLength

integer · int32

useCertificates

boolean

certificateCommonName

string | null

certificateValidityYears

integer · int32

Generates the participant's A, X and E keys locally as an asynchronous job. › Responses

200

Wraps the durable admission result returned with HTTP 202.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedResponse

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedData

Contains the durable admission data of one EBICS job.

status

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result · enum

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

POST/api/banking/v1/ebics/initialization/keys

curl 'https://api.365businessapi.com/api/banking/v1/ebics/initialization/keys?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "signatureVersion": "A005",
  "keyPassword": "<keyPassword>",
  "signatureKeyLength": 1,
  "protocolKeyLength": 1,
  "useCertificates": false,
  "certificateCommonName": "<certificateCommonName>",
  "certificateValidityYears": 1
}'

Example Request Body

{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "signatureVersion": "A005",
  "keyPassword": "<keyPassword>",
  "signatureKeyLength": 1,
  "protocolKeyLength": 1,
  "useCertificates": false,
  "certificateCommonName": "<certificateCommonName>",
  "certificateValidityYears": 1
}

json

application/json

Example Responses

{
  "data": {
    "jobId": "jobId",
    "jobType": "GenerateKeys",
    "jobStatus": "Accepted",
    "statusUrl": "statusUrl"
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

Sends the participant's signature key using INI.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/initialization/ini

key (query)

Sends the participant's signature key using INI. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Sends the participant's signature key using INI. › Headers

X-API-KEY

string · required

The x-api-key header value.

Sends the participant's signature key using INI. › Request Body

businessdev.blebics.Contracts.Requests.EbicsStateCommand

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Sends the participant's signature key using INI. › Responses

200

Wraps the durable admission result returned with HTTP 202.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedResponse

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedData

Contains the durable admission data of one EBICS job.

status

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result · enum

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

POST/api/banking/v1/ebics/initialization/ini

curl 'https://api.365businessapi.com/api/banking/v1/ebics/initialization/ini?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}'

Example Request Body

{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}

json

application/json

Example Responses

{
  "data": {
    "jobId": "jobId",
    "jobType": "GenerateKeys",
    "jobStatus": "Accepted",
    "statusUrl": "statusUrl"
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

Sends the participant's authentication and encryption keys using HIA.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/initialization/hia

key (query)

Sends the participant's authentication and encryption keys using HIA. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Sends the participant's authentication and encryption keys using HIA. › Headers

X-API-KEY

string · required

The x-api-key header value.

Sends the participant's authentication and encryption keys using HIA. › Request Body

businessdev.blebics.Contracts.Requests.EbicsStateCommand

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Sends the participant's authentication and encryption keys using HIA. › Responses

200

Wraps the durable admission result returned with HTTP 202.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedResponse

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedData

Contains the durable admission data of one EBICS job.

status

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result · enum

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

POST/api/banking/v1/ebics/initialization/hia

curl 'https://api.365businessapi.com/api/banking/v1/ebics/initialization/hia?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}'

Example Request Body

{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}

json

application/json

Example Responses

{
  "data": {
    "jobId": "jobId",
    "jobType": "GenerateKeys",
    "jobStatus": "Accepted",
    "statusUrl": "statusUrl"
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

Downloads bank keys with HPB and verifies their E002 and X002 hashes.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/initialization/bank-keys

key (query)

Downloads bank keys with HPB and verifies their E002 and X002 hashes. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Downloads bank keys with HPB and verifies their E002 and X002 hashes. › Headers

X-API-KEY

string · required

The x-api-key header value.

Downloads bank keys with HPB and verifies their E002 and X002 hashes. › Request Body

businessdev.blebics.Contracts.Requests.EbicsStateCommand

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Downloads bank keys with HPB and verifies their E002 and X002 hashes. › Responses

200

Wraps the durable admission result returned with HTTP 202.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedResponse

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobAcceptedData

Contains the durable admission data of one EBICS job.

status

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result · enum

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

POST/api/banking/v1/ebics/initialization/bank-keys

curl 'https://api.365businessapi.com/api/banking/v1/ebics/initialization/bank-keys?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}'

Example Request Body

{
  "connection": {
    "bankUrl": "https://example.com",
    "hostId": "<hostId>",
    "partnerId": "<partnerId>",
    "userId": "<userId>",
    "protocolVersion": "H003",
    "expectedEncryptionKeyHash": "<expectedEncryptionKeyHash>",
    "expectedAuthenticationKeyHash": "<expectedAuthenticationKeyHash>"
  },
  "state": {
    "bank": "BASE64_ENCODED_FILE",
    "partner": "BASE64_ENCODED_FILE",
    "user": "BASE64_ENCODED_FILE"
  },
  "keyPassword": "<keyPassword>"
}

json

application/json

Example Responses

{
  "data": {
    "jobId": "jobId",
    "jobType": "GenerateKeys",
    "jobStatus": "Accepted",
    "statusUrl": "statusUrl"
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

GetApiKey Jobs