...
MID | ans..30 | M | MerchantID, assigned by BNP Paribas. |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ns..30 | O | Unique reference number |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Status | a..50 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis. |
Code | n8 | M | Error code according to the payment platform Response Codes (Error codes) |
CodeExt | ans..256 | C | Error code from SofincoLimonetik. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with BNP Paribas support. |
ErrorText | ans..256 | C | Detailed Sofinco Limonetik error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with BNP Paribas support. |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
TransactionID | ans..50 | O | ID for identification of payment form |
...
Notice: For security reasons, the payment plarform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment plarform for the payment to be credited |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a..3 | M | Currency code, three digits DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment plarform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment plarform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
The following table describes the payment plarform response parameters:
MID | ans..30 | M | MerchantID, assigned by BNP Paribas |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes (Error codes) |
Reversal
To cancel a transaction with Sofinco via Limonetik, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be reverted |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a..3 | M | Currency code, three digits DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
The following table describes the payment platform response parameters:
MID | ans..30 | M | MerchantID, assigned by BNP Paribas |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes (Error codes) |
...
Batch processing via the interface
Basic information about using Batch files and about their structure you can find inside the separate manual for the Batch manager. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing of captures, credits and reversals for Sofinco via Limonetik and which information can be found within the response file about the payment status.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2x. | with RefNr (valid for all versions other than 1.0) |
The structure for a Sofinco payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> Limonetik,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> Limonetik,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> Limonetik,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Example for Master MID Function:
| HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Type | a..11 | M | HEAD for Header, FOOT for Footer, Limonetik for Limonetik |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Unique reference number |
PayID | an32 | M | ID for this transaction given by the payment platform |
The record area within the response file for Batch transactions looks the following way:
HEAD,<MerchantID>,<Date>,<Version> Limonetik,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> Limonetik,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> Limonetik,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
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):
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
PayID | an32 | M | ID for this transaction given by the payment platform |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to the payment plarform Response Codes (Error codes) |
...