DistributedSignatures

Retrieves the participant's VEU overview using HVU.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/distributedsignatures/overview

key (query)

Retrieves the participant's VEU overview using HVU. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Retrieves the participant's VEU overview using HVU. › Headers

X-API-KEY

string · required

The x-api-key header value.

Retrieves the participant's VEU overview using HVU. › Request Body

businessdev.blebics.Contracts.Requests.EbicsStateCommand

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Retrieves the participant's VEU overview using HVU. › 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/distributedsignatures/overview

curl 'https://api.365businessapi.com/api/banking/v1/ebics/distributedsignatures/overview?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

Retrieves details and display data for one VEU order using HVD.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/distributedsignatures/details

key (query)

Retrieves details and display data for one VEU order using HVD. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Retrieves details and display data for one VEU order using HVD. › Headers

X-API-KEY

string · required

The x-api-key header value.

Retrieves details and display data for one VEU order using HVD. › Request Body

businessdev.blebics.Contracts.Requests.DistributedSignatureOrderRequest

orderId

string

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Retrieves details and display data for one VEU order using HVD. › 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/distributedsignatures/details

curl 'https://api.365businessapi.com/api/banking/v1/ebics/distributedsignatures/details?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "orderId": "<orderId>",
  "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

{
  "orderId": "<orderId>",
  "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 the original business file of one VEU order into temporary Blob Storage.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/distributedsignatures/downloads

key (query)

Downloads the original business file of one VEU order into temporary Blob Storage. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Downloads the original business file of one VEU order into temporary Blob Storage. › Headers

X-API-KEY

string · required

The x-api-key header value.

Downloads the original business file of one VEU order into temporary Blob Storage. › Request Body

businessdev.blebics.Contracts.Requests.DistributedSignatureOrderRequest

orderId

string

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Downloads the original business file of one VEU order into temporary Blob Storage. › 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/distributedsignatures/downloads

curl 'https://api.365businessapi.com/api/banking/v1/ebics/distributedsignatures/downloads?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "orderId": "<orderId>",
  "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

{
  "orderId": "<orderId>",
  "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

Adds the participant's VEU signature using HVE.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/distributedsignatures/sign

key (query)

Adds the participant's VEU signature using HVE. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Adds the participant's VEU signature using HVE. › Headers

X-API-KEY

string · required

The x-api-key header value.

Adds the participant's VEU signature using HVE. › Request Body

businessdev.blebics.Contracts.Requests.DistributedSignatureOrderRequest

orderId

string

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Adds the participant's VEU signature using HVE. › 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/distributedsignatures/sign

curl 'https://api.365businessapi.com/api/banking/v1/ebics/distributedsignatures/sign?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "orderId": "<orderId>",
  "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

{
  "orderId": "<orderId>",
  "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

Cancels one VEU order using HVE.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/distributedsignatures/cancel

key (query)

Cancels one VEU order using HVE. › query Parameters

idempotencyKey

string · required

The idempotency key query value.

Cancels one VEU order using HVE. › Headers

X-API-KEY

string · required

The x-api-key header value.

Cancels one VEU order using HVE. › Request Body

businessdev.blebics.Contracts.Requests.DistributedSignatureOrderRequest

orderId

string

businessdev.blebics.Contracts.Requests.EbicsConnectionParameters

businessdev.blebics.Contracts.Responses.Objects.EbicsRuntimeState

keyPassword

string

Cancels one VEU order using HVE. › 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/distributedsignatures/cancel

curl 'https://api.365businessapi.com/api/banking/v1/ebics/distributedsignatures/cancel?idempotencyKey=<string>&key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <string>' \
  --data '{
  "orderId": "<orderId>",
  "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

{
  "orderId": "<orderId>",
  "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

Barcode GetApiKey