cancel (batch)
To search in the page use Ctrl+F on your keyboard
This function makes it possible to edit the amount of a transaction or to cancel a transaction to be sent to a bank.
You cannot cancel a cancelled operation and you cannot cancel an amount higher than the original one.
Request
Required
-
amount- presence
- Required
- Interface version
- 4
- Order
- 4
Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
currencyCode- presence
- Required
- Interface version
- 4
- Order
- 5
Currency code for the transaction. This code is ISO 4217 compatible.
List of values
032- Argentinean Peso
036- Australian Dollar
048- Bahrain Dinar
116- Cambodian Riel
124- Canadian Dollar
144- Sri Lanka Rupee
156- China Yuan Renminbi
191- Croatia Kuna
203- Czech Republic Koruna
208- Danes crown
344- Hong Kong dollar
348- Hungary Forint
352- Iceland Rupee
356- Indian rupee
376- Israel Shekel
392- Japanese Yen
410- South Korean Won
414- Kuwait Dinar
458- Malaysia Ringgit
480- Mauritius Rupee
484- Mexican Peso
524- Nepal Rupee
554- New Zealand Dollar
578- Norwegian crown
634- Qatar Riyal
643- Russia Ruble
682- Saudi Arabia Riyal
702- Singapore Dollar
710- South Africa Rand
752- Swedish crown
756- Swiss Franc
764- Thailand Baht
784- United Arab Emirates Dirham
788- Tunisia Dinar
826- Pound
840- American Dollar
901- Taiwan Dollar
941- Serbian Dinar
946- Roumania New Leu
949- New Turkish Lira
952- CFA Franc
953- CFP Franc
975- Bulgaria Lev
978- Euro
980- Ukraine Hryvnia
985- Poland Zloty
986- Brazilian Real
-
merchantId- presence
- Required
- Interface version
- 4
- Order
- 2
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
recordSequence- presence
- Required
- Interface version
- 4
- Order
- 1
Transaction order in a Sogenactif Office Batch file.
-
transactionReference- presence
- Required
- Interface version
- 4
- Order
- 3
The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.
Optional
-
operationOrigin- presence
- Optional
- Interface version
- 4
- Order
- 6
Origin of an operation (for example: name of the program), set by the sender of the request (merchant or Sogenactif).This field will be present in the operations log sent to the merchant on a daily basis.
-
s10TransactionReference- presence
- Optional
- Interface version XML
- 5
- Interface version CSV
- 5
- Order
- 7
Contains the identification of the transaction (to be compliant with Sogenactif 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
-
s10TransactionId- presence
- Required
- Interface version
- 4
The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Sogenactif 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
-
s10TransactionIdDate- presence
- Optional
- Interface version
- 4
Date of the transaction (expressed in the Sogenactif server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
Request sample
FILE;request;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1
CANCEL;2;023101122334456;SIM20220329092501;66;978;origin;101;20210329
END;13
<?xml version="1.0" encoding="UTF-8"?>
<file format="office" type="request" version="5">
<header>
<remitterId>023101122334455</remitterId>
<date>2018-07-25+02:00</date>
<time>09:00:00+01:00</time>
<sequence>1</sequence>
</header>
<body>
<cancel recordSequence="1">
<merchantId>023101122334456</merchantId>
<transactionReference>SIM20220329092501</transactionReference>
<amount>66</amount>
<currencyCode>978</currencyCode>
<operationOrigin>origin</operationOrigin>
<s10TransactionReference>
<s10TransactionId>101</s10TransactionId>
<s10TransactionIdDate>20210329</s10TransactionIdDate>
</s10TransactionReference>
</cancel>
</body>
<end nbRecord="1" />
</file>
Response
Required
-
amount- presence
- Required
- Interface version
- 4
- Order
- 4
Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
currencyCode- presence
- Required
- Interface version
- 4
- Order
- 5
Currency code for the transaction. This code is ISO 4217 compatible.
List of values
032- Argentinean Peso
036- Australian Dollar
048- Bahrain Dinar
116- Cambodian Riel
124- Canadian Dollar
144- Sri Lanka Rupee
156- China Yuan Renminbi
191- Croatia Kuna
203- Czech Republic Koruna
208- Danes crown
344- Hong Kong dollar
348- Hungary Forint
352- Iceland Rupee
356- Indian rupee
376- Israel Shekel
392- Japanese Yen
410- South Korean Won
414- Kuwait Dinar
458- Malaysia Ringgit
480- Mauritius Rupee
484- Mexican Peso
524- Nepal Rupee
554- New Zealand Dollar
578- Norwegian crown
634- Qatar Riyal
643- Russia Ruble
682- Saudi Arabia Riyal
702- Singapore Dollar
710- South Africa Rand
752- Swedish crown
756- Swiss Franc
764- Thailand Baht
784- United Arab Emirates Dirham
788- Tunisia Dinar
826- Pound
840- American Dollar
901- Taiwan Dollar
941- Serbian Dinar
946- Roumania New Leu
949- New Turkish Lira
952- CFA Franc
953- CFP Franc
975- Bulgaria Lev
978- Euro
980- Ukraine Hryvnia
985- Poland Zloty
986- Brazilian Real
-
merchantId- presence
- Required
- Interface version
- 4
- Order
- 2
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
officeBatchResponseCode- presence
- Required
- Interface version
- 4
- Order
- 12
officeBatchResponseCode completes the result of the processing of a payment request handled by which would be rejected (classic reject responseCode) and contains the field of the payment request that is in error.
List of values
00- None (all fields are correct)
01- merchantId error
03- transactionReference error
04- merchantTransactionDateTime error
05- amount error
06- captureDay error
07- captureMode error
08- operationAmount error
09- operationOrigin error
11- currencyCode error
12- customerIpAddress error
13- customerEmail error
14- customerId error
16- orderId error
17- orderChannel error
18- transactionOrigin error
19- returnContext error
20- fromTransactionReference error
21- cardExpiryDate error
22- cardNumber error
23- cardCSCValue error
24- cardEffectiveDate error
25- cardSeqNumber error
26- paymentMeanBrand error
27- authorisationId error
28- merchantWalletId error
29- paymentMeanId error
30- paymentPattern error
31- number error
32- statementReference error
33- panType error
34- mandateId error
35- valueDate error
36- paymentMeanAlias error
37- account error
38- bankCode error
39- transactionActors error
45- Date fields format error
46- settlementMode error
47- comment error
48- validationIndicator error
50- s10TransactionId error
51- s10TransactionIdDate error
52- s10FromTransactionId error
53- s10FromTransactionIdDate error
54- fraudData error
55- riskManagementDynamicParam error
56- riskManagementDynamicValue error
57- riskManagementDynamicSettingList error
58- fraudListReason error
59- fraudListType error
60- fraudListLevel error
61- fraudListElementType error
62- fraudListElementValue error
63- lastRecoveryIndicator error
64- orderContext error
65- travelContext error
66- deliveryData error
67- address error
68- contact error
69- cardAuthPolicy error
70- shoppingCartDetail error
71- merchantExternalId error
72- paymentMeansBrandSelectionStatus error
73- settlementArchivingReference error
74- settlementMerchantSpecificData error
75- fromTransactionAcceptor error
80- Merchant not registered to use Sogenactif Office Batch / Merchant not linked to the remitter declared in the header.
-
recordSequence- presence
- Required
- Interface version
- 4
- Order
- 1
Transaction order in a Sogenactif Office Batch file.
Optional
-
newAmount- presence
- Optional
- Interface version
- 4
- Order
- 11
Amount of the transaction updated after checkout operation.For example, if after having completed an accepted authorisation request for EUR 10.00, a merchant cancels EUR 3.00, the newAmount field at the end of the cancellation shall be EUR 7.00.The amount is transmitted in the smallest unit of currency.Example for euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
newStatus- presence
- Optional
- Interface version
- 4
- Order
- 10
Status of the transaction updated after a checkout operation. The status of a transaction is described by different keywords which change during the operations it undergoes.
List of values
ABORTED- Transaction totally aborted
CANCELLED- Transaction totally cancelled
CAPTURED- Transaction sent to the bank
CAPTURE_REFUSED- Capture refused
CREDITED- Transaction totally refund
ENDED- Transaction ended
EXPIRED- Transaction expired
PENDING- Transaction waiting for the authorisation request response
PREPROD- Transaction of a merchant which is in the pre-production mode. It cannot be settled.
REFUSED- Transaction refused
TO_AUTHORIZE- Transaction waiting for the authorisation request
TO_CAPTURE- Transaction to send to the bank to debit the user
TO_CHALLENGE- Transaction with a fraud suspicion
TO_CONFIRM_AUTHOR- Transaction waiting for confirmation of authorization.
TO_CONFIRM_CAPTURE- Transaction waiting for confirmation of settlement
TO_CONFIRM_CREDITTO_CREDIT- Transaction to send to the bank to credit the user
TO_REPLAY- Transaction waiting for a validation with authorization request
TO_VALIDATE- Transaction waiting for a validation
UNDEFINED- Transaction status not defined
WAITING_AUTHOR- Technical status for transaction in a temporarily state waiting for a authorisation batch response
-
operationDateTime- presence
- Optional
- Interface version
- 4
- Order
- 8
Date and time calculated by Sogenactif on which the transaction has been completed.
-
operationOrigin- presence
- Optional
- Interface version
- 4
- Order
- 6
Origin of an operation (for example: name of the program), set by the sender of the request (merchant or Sogenactif).This field will be present in the operations log sent to the merchant on a daily basis.
-
responseCode- presence
- Optional
- Interface version
- 4
- Order
- 9
Sogenactif server response code.
List of values
00- Operation accepted
01- For panToToken and tokenToPan methods, partial success
02- Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
03- Invalid merchant contract
05- Refused authorization
11- Used for differed check. The PAN is blocked
12- Invalid transaction. Please check the request parameters
14- Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
17- Customer cancellation
24- In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
- In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
25- Transaction unknown by Sogenactif
30- Format error
34- Fraud suspicion (seal erroneous)
40- Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
51- Amount too high
54- Payment mean expiry date is past
55- Merchant doesn’t accept prepaid cards
57- Refund operation refused because the original transaction was subject of an unpaid
60- Transaction pending
62- Waiting the confirmation for the transaction (used by PayPal 1.0)
63- Security rules not observed, transaction stopped
75- Number of attempts to enter the data of the payment mean from Sogenactif Paypage is exceeded
90- Service temporarily not available
94- Duplicated transaction: the transactionReference has been used previously
97- Session expired (no action from the user during 15 minutes), transaction refused
99- Temporarily problem with the payment server
-
s10TransactionReference- presence
- Optional
- Interface version XML
- 5
- Interface version CSV
- 5
- Order
- 7
Contains the identification of the transaction (to be compliant with Sogenactif 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
-
s10TransactionId- presence
- Required
- Interface version
- 4
The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Sogenactif 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
-
s10TransactionIdDate- presence
- Optional
- Interface version
- 4
Date of the transaction (expressed in the Sogenactif server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
-
transactionReference- presence
- Optional
- Interface version
- 4
- Order
- 3
The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.
Response sample
FILE;response;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1;00;2021-12-16T00:00:00+0100;2021-12-16T00:00:00+0100
CANCEL;2;023101122334456;SIM20220329092501;66;978;origin;101;20210329;operationDateTime;00;TO_CAPTURE;65;00
END;1
<?xml version="1.0" encoding="UTF-8"?>
<file version="v19" format="office" type="response">
<header>
<remitterId>023101122334455</remitterId>
<date>2021-12-16+01:00</date>
<time>14:26:45+01:00</time>
<sequence>1</sequence>
<processingResponseCode>00</processingResponseCode>
<beginProcessTime>2021-12-16T00:00:00+01:00</beginProcessTime>
<endProcessTime>2021-12-16T00:00:00+01:00</endProcessTime>
</header>
<body>
<cancel recordSequence="1">
<merchantId>023101122334456</merchantId>
<transactionReference>SIM20220329092501</transactionReference>
<amount>66</amount>
<currencyCode>978</currencyCode>
<operationOrigin>origin</operationOrigin>
<s10TransactionReference>
<s10TransactionId>101</s10TransactionId>
<s10TransactionIdDate>20210329</s10TransactionIdDate>
</s10TransactionReference>
<operationDateTime>operationDateTime</operationDateTime>
<responseCode>00</responseCode>
<newStatus>TO_CAPTURE</newStatus>
<newAmount>65</newAmount>
<officeBatchResponseCode>00</officeBatchResponseCode>
</cancel>
</body>
<end nbRecord="1" />
</file>
Changelog
| Interface version | Data | Attendance | Container |
|---|---|---|---|
| 4 |
amount
|
Request/Response | |
| 4 |
currencyCode
|
Request/Response | |
| 4 |
merchantId
|
Request/Response | |
| 4 |
recordSequence
|
Request/Response | |
| 4 |
transactionReference
|
Request/Response | |
| 4 |
operationOrigin
|
Request/Response | |
| {"XML"=>"5", "CSV"=>"5"} |
s10TransactionReference
|
Request/Response | |
| 4 |
s10TransactionId
|
Container |
s10TransactionReference
|
| 4 |
s10TransactionIdDate
|
Container |
s10TransactionReference
|
| 4 |
officeBatchResponseCode
|
Response | |
| 4 |
newAmount
|
Response | |
| 4 |
newStatus
|
Response | |
| 4 |
operationDateTime
|
Response | |
| 4 |
responseCode
|
Response |
