Bank Accounting | Batch Payments
The Payment Batches end point is used to record all business transactions and events to generate the electronic payments/receivables File like SEPA File or meal card.
Overview
| URL | api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches |
| Methods Supported | GET, PUT, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
-
PUT:
- PUT Set Custom Attribute PaymentBatch
- PUT Set Custom Attribute PaymentBatchLine
- PUT Set IsActive PaymentBatch
- PUT Set FinancialAccount PaymentBatch
- PUT Set Note PaymentBatch
- PUT Set Company PaymentBatch
- PUT Set Remarks PaymentBatch
- PUT Set AllowExport PaymentBatch
- PUT Set Status PaymentBatchLine
- PUT Set Swift PaymentBatchLine
- PUT Set IBAN PaymentBatchLine
- PUT Set PaymentInstruction PaymentBatchLine
- POST:
- DELETE:
All Resources
This service uses the following resources:
- ApiPaymentBatchPaymentBatchLinesResource
- ApiPaymentBatchResource
- MoneyResource
- PaymentBatchLineResource
- PaymentBatchResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET PaymentBatches
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See PaymentBatchResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches
GET /bankAccounting/paymentBatches
GET PaymentBatches (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See PaymentBatchResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches?page={page}&pageSize={pageSize}
GET /bankAccounting/paymentBatches?page={page}&pageSize={pageSize}
GET PaymentBatch by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See PaymentBatchResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{id}
GET /bankAccounting/paymentBatches/{id}
GET PaymentBatch by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
Response:
| When successful, the response body contains the entity record. See PaymentBatchResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}
GET /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}
GET Print PaymentBatch by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{id}/print?template={template}
GET /bankAccounting/paymentBatches/{id}/print?template={template}
GET Print PaymentBatch by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/print
GET /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/print
GET Original Print PaymentBatchOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{id}/printOriginal?template={template}
GET /bankAccounting/paymentBatches/{id}/printOriginal?template={template}
GET Original Print PaymentBatch by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/printOriginal
GET /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/printOriginal
POST Batch Payments
Inserts a new 'Batch Payments Line' in the 'Batch Payments'.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (ApiPaymentBatchPaymentBatchLinesResource) The ApiPaymentBatchPaymentBatchLinesResource instance. See ApiPaymentBatchPaymentBatchLinesResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines
POST /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines
PUT Set AllowExport PaymentBatch
Updates the value of attribute 'AllowExport' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/allowExport
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/allowExport
PUT Set Company PaymentBatch
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/company
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/company
PUT Set FinancialAccount PaymentBatch
Updates the value of attribute 'FinancialAccount' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/financialAccount
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/financialAccount
PUT Set IBAN PaymentBatchLine
Updates the value of attribute 'IBAN' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/iBAN
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/iBAN
PUT Set IsActive PaymentBatch
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/isActive
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/isActive
PUT Set Note PaymentBatch
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/note
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/note
PUT Set PaymentInstruction PaymentBatchLine
Updates the value of attribute 'PaymentInstruction' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/paymentInstruction
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/paymentInstruction
PUT Set Remarks PaymentBatch
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/remarks
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/remarks
PUT Set Status PaymentBatchLine
Updates the value of attribute 'Status' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (enum PaymentBatchLineState) The request body should contain the new value for the attribute. See PaymentBatchLineState. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/status
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/status
PUT Set Swift PaymentBatchLine
Updates the value of attribute 'Swift' in the specified entity record.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/swift
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/swift
PUT Set Custom Attribute PaymentBatch
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/{customAttributeName}
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/{customAttributeName}
PUT Set Custom Attribute PaymentBatchLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| lineId | (string) The detail identifier. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/{customAttributeName}
PUT /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}/{customAttributeName}
DELETE Batch Payments Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| companyKey | (string) The company key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}
DELETE /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}/paymentBatchLines/{lineId}
DELETE PaymentBatch by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{id}
DELETE /bankAccounting/paymentBatches/{id}
DELETE PaymentBatch by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}
DELETE /bankAccounting/paymentBatches/{companyKey}/{paymentBatchKey}
Resources
ApiPaymentBatchPaymentBatchLinesResource
The following elements are required:
| party | (string) Indicates the entity of the original document. |
| discountAmount | (MoneyResource) The discount amount of the original document.
See MoneyResource . |
| withholdedAmount | (MoneyResource) The witholded amount of the sourcedoc.
See MoneyResource . |
| transferAmount | (MoneyResource) The amount that will be transfered of the sourcedoc.
See MoneyResource . |
| currency | (string) The currency of the sourcedoc. |
| accountPosting | (string) The account posting. |
| status | (enum PaymentBatchLineState) The current status (updated automatically or manually).
See PaymentBatchLineState. |
The following elements are optional:
| sourceDoc | (string) The original document identification. |
| swift | (string) The SWIFT from the partie bank. |
| iBAN | (string) The IBAN from the partie bank. |
| paymentInstruction | (string) The Payment Instruction from the partie. |
| note | (string) The original document. |
ApiPaymentBatchResource
The following elements are required:
| documentDate | (DateTime) The document date of payment batch. |
| currency | (string) The Payment Batch currency. Indicates the money unit used by the generated document. |
| company | (string) The Payment Batch company. The company code is the central organizational unit within the system. |
| exchangeRate | (decimal) The exchange rate. |
| paymentMethod | (string) The Payment Method. |
| bankAccountType | (string) Type of bank account type(ex: 01). |
The following elements are optional:
| financialAccount | (string) The financial account of document batch. |
| note | (string) The note. |
| remarks | (string) The remarks. |
| paymentBatchLines | (List of ApiPaymentBatchPaymentBatchLinesResource) The details.
See ApiPaymentBatchPaymentBatchLinesResource. |
| allowExport | (bool) Allow Export. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
PaymentBatchLineResource
The following elements are required:
| party | (string) Indicates the entity of the original document. |
| documentAmount | (MoneyResource) The document amount of the original document.
See MoneyResource . |
| discountAmount | (MoneyResource) The discount amount of the original document.
See MoneyResource . |
| withholdedAmount | (MoneyResource) The witholded amount of the sourcedoc.
See MoneyResource . |
| transferAmount | (MoneyResource) The amount that will be transfered of the sourcedoc.
See MoneyResource . |
| currency | (string) The currency of the sourcedoc. |
| accountPosting | (string) The account posting. |
| status | (enum PaymentBatchLineState) The current status (updated automatically or manually).
See PaymentBatchLineState. |
The following elements are optional:
| sourceDoc | (string) The original document identification. |
| exportTransactionGroupId | (string) The export transaction group id is the group of transaction identifier of the sepa. |
| exportTransactionId | (string) The export transaction id is the idenfier of the SEPA transaction. |
| externalStatusCode | (string) The return code of the bank with the result of the transaction. |
| externalStatusReportId | (string) The externa status report id is the identifier of the report send by the bank. |
| swift | (string) The SWIFT from the partie bank. |
| iBAN | (string) The IBAN from the partie bank. |
| paymentInstruction | (string) The Payment Instruction from the partie. |
| dueDate | (DateTime) The due date of the source doc. |
| note | (string) The original document. |
| originalSwift | (string) Original Swift. |
| originalIBAN | (string) Original IBAN. |
| originalPaymentInstruction | (string) Original Payment Instruction. |
| originalStatusId | (Guid) Original Status Id. |
| originalAccountPostingId | (Guid) Original Account Posting Id. |
PaymentBatchResource
The following elements are required:
| paymentBatchKey | (int) The payment batch key is the key of the entity and is a autonumber. |
| numberOfOpenItems | (int) The number of open items is the total of documents on details. |
| documentDate | (DateTime) The document date of payment batch. |
| currency | (string) The Payment Batch currency. Indicates the money unit used by the generated document.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| openAmount | (MoneyResource) The Open Amount field is updated automatically, showing the remaining, unmatched amount of the settlement.
See MoneyResource . |
| totalAmount | (MoneyResource) The Batch Payment total. Indicates the total amount of open items.
See MoneyResource . |
| company | (string) The Payment Batch company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| exchangeRate | (decimal) The exchange rate. |
| paymentMethod | (string) The Payment Method.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service. |
| status | (enum PaymentBatchState) The status of the payment batch.
See PaymentBatchState. |
| bankAccountType | (string) Type of bank account type(ex: 01).
(fk) Allowed value: the natural key of a record of type BankAccountType. These records are accessibly through the BankAccountTypes service. |
The following elements are optional:
| financialAccount | (string) The financial account of document batch.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
| note | (string) The note. |
| remarks | (string) The remarks. |
| paymentBatchLines | (List of PaymentBatchLineResource) The details.
See PaymentBatchLineResource. |
| originalFinancialAccountId | (Guid) Original Financial Account Id. |
| allowExport | (bool) Allow Export. |
| originalStatusId | (Guid) Original Status Id. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |
Enumerations
PaymentBatchLineState
| 1 | Open | Payment is open this status may mean you are waiting for a response about the payment from the bank. |
| 2 | Error | The bank was unable to make the payment. |
| 3 | Success | The bank was able to make the payment. |
PaymentBatchState
| 1 | Draft | The document in this state means you can still add or remove paylines. |
| 2 | Submitted | Document in this state means you have submitted payment information to your bank. |
| 3 | PartiallyCompleted | The document in this state means already got responses regarding payments. |
| 4 | FinishedWithErrors | Document in this state means your bank was unable to make all payments. |
| 5 | FinishedWithoutErrors | The document in this state means your bank was able to make all payments. |
| 6 | Discarded | The document is Discarded. |