Jobs

Returns the durable processing status and an optional replacement SDK state.

GET

https://api.365businessapi.com

/api/banking/v1/ebics/jobs/{jobId}

key (query)

Returns the durable processing status and an optional replacement SDK state. › path Parameters

jobId

string · required

The job id path value.

Returns the durable processing status and an optional replacement SDK state. › Headers

X-API-KEY

string · required

The x-api-key header value.

Returns the durable processing status and an optional replacement SDK state. › Responses

200

Wraps the complete durable status of one EBICS job.

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobStatusResponse

businessdev.API.Models.Banking.v1.EBICS.BlebicsJobStatusData

Contains every result field that can be produced by an EBICS job.

status

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

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

GET/api/banking/v1/ebics/jobs/{jobId}

curl 'https://api.365businessapi.com/api/banking/v1/ebics/jobs/:jobId?key=<api-key>' \
  --header 'X-API-KEY: <string>'

Example Responses

{
  "data": {
    "jobId": "jobId",
    "jobType": "GenerateKeys",
    "jobStatus": "Accepted",
    "attemptCount": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "orderNumber": "orderNumber",
    "state": {
      "bank": "bank",
      "partner": "partner",
      "user": "user"
    },
    "recoveryState": {
      "bank": "bank",
      "partner": "partner",
      "user": "user"
    },
    "transferCheckpoint": "U3dhZ2dlcg==",
    "signatureKey": {
      "version": "version",
      "hash": "hash",
      "modulus": "modulus",
      "exponent": "exponent"
    },
    "encryptionKey": {
      "version": "version",
      "hash": "hash",
      "modulus": "modulus",
      "exponent": "exponent"
    },
    "authenticationKey": {
      "version": "version",
      "hash": "hash",
      "modulus": "modulus",
      "exponent": "exponent"
    },
    "payloadAvailable": true,
    "noDataAvailable": true,
    "distributedSignatureOrders": [
      {
        "partnerId": "partnerId",
        "orderId": "orderId",
        "orderType": "orderType",
        "service": {
          "serviceName": "serviceName",
          "messageName": "messageName",
          "scope": "scope",
          "serviceOption": "serviceOption",
          "containerType": "containerType",
          "messageFormat": "messageFormat",
          "messageVariant": "messageVariant",
          "messageVersion": "messageVersion"
        },
        "dataSize": 0,
        "signaturesCompleted": 0,
        "signaturesRequired": 0,
        "readyToSign": true,
        "createdAt": "2024-08-25T15:00:00Z",
        "totalAmount": "totalAmount",
        "currency": "currency"
      }
    ],
    "distributedSignatureDetails": {
      "order": {
        "partnerId": "partnerId",
        "orderId": "orderId",
        "orderType": "orderType",
        "service": {
          "serviceName": "serviceName",
          "messageName": "messageName",
          "scope": "scope",
          "serviceOption": "serviceOption",
          "containerType": "containerType",
          "messageFormat": "messageFormat",
          "messageVariant": "messageVariant",
          "messageVersion": "messageVersion"
        },
        "dataSize": 0,
        "signaturesCompleted": 0,
        "signaturesRequired": 0,
        "readyToSign": true,
        "createdAt": "2024-08-25T15:00:00Z",
        "totalAmount": "totalAmount",
        "currency": "currency"
      },
      "displayFile": "displayFile",
      "orderDataAvailable": true
    },
    "payloadLength": 0,
    "payloadSha256": "payloadSha256",
    "errorCode": "CredentialsRequired",
    "nativeReporter": 0,
    "nativeErrorCode": "nativeErrorCode",
    "ebicsReturnCode": "ebicsReturnCode"
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

Streams the business payload produced by a successful download job.

GET

https://api.365businessapi.com

/api/banking/v1/ebics/jobs/{jobId}/payload

key (query)

Streams the business payload produced by a successful download job. › path Parameters

jobId

string · required

The job id path value.

Streams the business payload produced by a successful download job. › Headers

X-API-KEY

string · required

The x-api-key header value.

Streams the business payload produced by a successful download job. › Responses

200

No data returned

Removes an ambiguous job after BC has reconciled and stored its bank-side outcome.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/jobs/{jobId}/resolve

key (query)

Removes an ambiguous job after BC has reconciled and stored its bank-side outcome. › path Parameters

jobId

string · required

The job id path value.

Removes an ambiguous job after BC has reconciled and stored its bank-side outcome. › Headers

X-API-KEY

string · required

The x-api-key header value.

Removes an ambiguous job after BC has reconciled and stored its bank-side outcome. › Responses

200

Represents a successful acknowledgement without additional business data.

businessdev.API.Models.Banking.v1.EBICS.EbicsAcknowledgeResponse

status

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

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

Confirms that BC persisted the complete result and deletes transient Cosmos and Blob data.

POST

https://api.365businessapi.com

/api/banking/v1/ebics/jobs/{jobId}/acknowledge

key (query)

Confirms that BC persisted the complete result and deletes transient Cosmos and Blob data. › path Parameters

jobId

string · required

The job id path value.

Confirms that BC persisted the complete result and deletes transient Cosmos and Blob data. › Headers

X-API-KEY

string · required

The x-api-key header value.

Confirms that BC persisted the complete result and deletes transient Cosmos and Blob data. › Responses

200

Represents a successful acknowledgement without additional business data.

businessdev.API.Models.Banking.v1.EBICS.EbicsAcknowledgeResponse

status

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

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

Initialization KeyManagement