Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
Multiexcerpt include |
---|
SpaceWithExcerpt | EN |
---|
MultiExcerptName | Batch_Intro |
---|
PageWithExcerpt | Reuse API |
---|
|
This section describes the parameters which must be transferred within the data set (Record) for executing an Bluecode payment and information can be found within the response file about the payment status
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Table Filter |
---|
default | Beschreibung |
---|
isFirstTimeEnter | false |
---|
hideColumns | true |
---|
sparkName | Sparkline |
---|
hidePane | true |
---|
datepattern | dd M yy |
---|
id | 1646657880048_1239938350 |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
isOR | AND |
---|
separator | Point (.) |
---|
order | 0 |
---|
|
Multiexcerpt |
---|
MultiExcerptName | batch_versions |
---|
| Table Transformer |
---|
dateFormat | dd M yy |
---|
export-word | false |
---|
show-source | false |
---|
export-csv | false |
---|
id | 1646657880050_-732519817 |
---|
transpose | false |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
separator | . |
---|
export-pdf | false |
---|
sql | SELECT * FROM T* |
---|
| Action | Version | Description | Beschreibung |
---|
Credit | 1.0 / 2.0 | Standard version without return of parameter Code | Standardversion ohne Rückgabe von Parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) | mit RefNr (gilt für alle Versionen außer 1.0) |
|
|
|
Description of the possible batch versions
The structure for a Bluecode credit within a Batch file to be submitted is as follows:
Multiexcerpt |
---|
MultiExcerptName | batch_structure |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Code Block |
---|
| HEAD,<MerchantID>,<Date>,<Version>
Bluecode,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount> |
|
Example for Master MID function:
Multiexcerpt |
---|
MultiExcerptName | batch_MasterMid |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Code Block |
---|
| HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount |
|
Multiexcerpt include |
---|
SpaceWithExcerpt | EN |
---|
MultiExcerptName | Batch_Request_Intro |
---|
PageWithExcerpt | Reuse API |
---|
|
The following table describes the individual fields and values used within the data set (record) in the batch file:
Table Filter |
---|
default | Beschreibung |
---|
isFirstTimeEnter | false |
---|
hideColumns | true |
---|
sparkName | Sparkline |
---|
hidePane | true |
---|
datepattern | dd M yy |
---|
id | 1646657978099_1254442961 |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
isOR | AND |
---|
separator | Point (.) |
---|
order | 0 |
---|
|
Multiexcerpt |
---|
MultiExcerptName | batch_request |
---|
| Table Transformer |
---|
dateFormat | dd M yy |
---|
export-word | false |
---|
show-source | false |
---|
export-csv | false |
---|
id | 1646657978100_2049204531 |
---|
transpose | false |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
separator | . |
---|
export-pdf | false |
---|
sql | SELECT * FROM T* |
---|
| Key | Format | CND | Description | Beschreibung |
---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, Bluecode for Bluecode | HEAD für Header, FOOT für Footer, Bluecode für Bluecode | Action | a..20 | M | The parameter Action defines the type of transaction: Credit | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift) |
Table Excerpt Include |
---|
name | Amount |
---|
page | Amount |
---|
type | page |
---|
|
Table Excerpt Include |
---|
static | true |
---|
name | Currency |
---|
page | Currency |
---|
type | page |
---|
|
Table Excerpt Include |
---|
static | true |
---|
name | TransID |
---|
page | TransID |
---|
type | page |
---|
|
Key | Format | CND | Description | Beschreibung |
---|
RefNr | ans..30 | O | Unique reference number for your accounts. The value is not sent to Bluecode with a credit. | Eindeutige Referenznummer für Ihre Buchhaltung. Der Wert wird bei der Gutschrift nicht an Bluecode gesendet. |
Table Excerpt Include |
---|
static | true |
---|
name | PayID_Batch |
---|
page | PayID |
---|
type | page |
---|
|
|
|
|
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
Multiexcerpt |
---|
MultiExcerptName | batch_structure_response |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Code Block |
---|
| HEAD,<MerchantID>,<Date>,<Version>
Bluecode,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount> |
|
Multiexcerpt include |
---|
SpaceWithExcerpt | EN |
---|
MultiExcerptName | Batch_Response_Intro |
---|
PageWithExcerpt | Reuse API |
---|
|
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Table Filter |
---|
default | Beschreibung |
---|
isFirstTimeEnter | false |
---|
hideColumns | true |
---|
sparkName | Sparkline |
---|
hidePane | true |
---|
datepattern | dd M yy |
---|
id | 1646658967828_-583795155 |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
isOR | AND |
---|
separator | Point (.) |
---|
order | 0 |
---|
|
Multiexcerpt |
---|
MultiExcerptName | batch_response |
---|
| Table Transformer |
---|
dateFormat | dd M yy |
---|
export-word | false |
---|
show-source | false |
---|
export-csv | false |
---|
id | 1646658967830_1164745410 |
---|
transpose | false |
---|
worklog | 365|5|8|y w d h m|y w d h m |
---|
separator | . |
---|
export-pdf | false |
---|
sql | SELECT * FROM T* |
---|
| Key | Format | CND | Description | Beschreibung |
---|
Action | a..20 | M | The parameter Action defines the type of transaction: Credit | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift) |
Table Excerpt Include |
---|
static | true |
---|
name | PayID_Batch |
---|
page | PayID |
---|
type | page |
---|
|
Table Excerpt Include |
---|
static | true |
---|
name | Status_OK_FAILED |
---|
page | Status |
---|
type | page |
---|
|
Table Excerpt Include |
---|
static | true |
---|
name | Code |
---|
page | Code |
---|
type | page |
---|
|
|
|
|
Description of result parameters within the record for Batch files