BankPayment

Zahlungen

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/erp/bank/payments/{id}

HTTPcURLJavaScriptPython

GET /api/erp/bank/payments/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:30.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:30.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "MONEY_TRANSFER",
  "status": "CREATED",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:30.523Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:30.523Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

typestring · enumRequired

payment type

Possible values:

statusstring · enumRead-onlyOptional

payment status

Possible values:

batchBookingPreferredbooleanOptional

batch booked preferred

directDebitSequenceTypestring · enumOptional

direct debit sequence type

Possible values:

executionDatestring · dateOptional

execution date

requestDatestring · date-timeOptional

request date

endToEndIdstringOptionalDeprecated

End-To-End-Id

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/bank/payments/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/bank/payments/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 529

{
  "version": "text",
  "info": {},
  "id": "text",
  "accountRef": {
    "id": "text"
  },
  "type": "MONEY_TRANSFER",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text"
      }
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:30.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:30.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "MONEY_TRANSFER",
  "status": "CREATED",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:30.523Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:30.523Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/erp/bank/payments/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/bank/payments/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

typestring · enumRequired

payment type

Possible values:

statusstring · enumRead-onlyOptional

payment status

Possible values:

batchBookingPreferredbooleanOptional

batch booked preferred

directDebitSequenceTypestring · enumOptional

direct debit sequence type

Possible values:

executionDatestring · dateOptional

execution date

requestDatestring · date-timeOptional

request date

endToEndIdstringOptionalDeprecated

End-To-End-Id

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/erp/bank/payments

HTTPcURLJavaScriptPython

POST /api/erp/bank/payments HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 529

{
  "version": "text",
  "info": {},
  "id": "text",
  "accountRef": {
    "id": "text"
  },
  "type": "MONEY_TRANSFER",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text"
      }
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:30.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:30.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "MONEY_TRANSFER",
  "status": "CREATED",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:30.523Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:30.523Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

post

Path parameters

paymentIdinteger · int64Required

ID der Zahlung

Responses

200

OK

application/json

post

/erp/bank/payments/{paymentId}/send

HTTPcURLJavaScriptPython

POST /api/erp/bank/payments/{paymentId}/send HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "description": "text",
    "type": "OPEN_URL",
    "expiration": "2026-02-10T15:56:30.523Z",
    "payload": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

post

Body

application/json

bankPaymentIdinteger · int64Required

Zahlung

bankPaymentRecordIdinteger · int64Required

Zahlungssatz

amountnumberOptional

geänderter Zahlbetrag

commentstringOptional

Kommentar

Responses

200

OK

application/json

post

/erp/bank/payments/change_amount

HTTPcURLJavaScriptPython

POST /api/erp/bank/payments/change_amount HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "bankPaymentId": 1,
  "bankPaymentRecordId": 1,
  "amount": 1,
  "comment": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:30.523Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:30.523Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "MONEY_TRANSFER",
  "status": "CREATED",
  "batchBookingPreferred": true,
  "directDebitSequenceType": "OOFF",
  "executionDate": "2026-02-10",
  "requestDate": "2026-02-10T15:56:30.523Z",
  "records": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:30.523Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:30.523Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "paymentId": 1,
      "name": "text",
      "iban": "text",
      "bic": "text",
      "amount": 1,
      "purpose": "text",
      "purposeCode": "text",
      "mandateReference": "text",
      "mandateDate": "2026-02-10",
      "creditorId": "text",
      "address": "text",
      "country": "text",
      "comment": "text",
      "openItem": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

get

Path parameters

paymentIdinteger · int64Required

ID der Zahlung

Responses

200

OK

application/json

get

/erp/bank/payments/{paymentId}/actions

HTTPcURLJavaScriptPython

GET /api/erp/bank/payments/{paymentId}/actions HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "description": "text",
    "type": "OPEN_URL",
    "expiration": "2026-02-10T15:56:30.523Z",
    "payload": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]