Release 24.5

go directly to content

Search by keywords

refund (batch)

To search in the page use Ctrl+F on your keyboard

This function makes it possible to re-credit the buyer’s account.

Required

  • 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 Sherlock’s during the shop registration.

  • operationAmount
    presence
    Required
    Interface version
    4
    Order
    4

    Amount of the operation (refund, cancellation, validation etc). The amount must be transmitted in the smallest unit of currency.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • recordSequence
    presence
    Required
    Interface version
    4
    Order
    1

    Transaction order in a Sherlock’s Office Batch file.

Optional

Request sample

            FILE;request;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1
REFUND;9;023101122334456;SIM20220329092501;66;978;origin;101;20210329;settlementArchivingReference;settlementMerchantSpecificData
END;1

        
            <?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>
		<refund recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <operationAmount>66</operationAmount>
            <currencyCode>978</currencyCode>
            <operationOrigin>origin</operationOrigin>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <shoppingCartDetail>
                <shoppingCartTotalAmount>66</shoppingCartTotalAmount>
                <shoppingCartTotalQuantity>1</shoppingCartTotalQuantity>
                <shoppingCartTotalTaxAmount>2</shoppingCartTotalTaxAmount>
                <mainProduct>main</mainProduct>
                <ShoppingCartItemList>
                    <shoppingCartItem>
                        <productName>name</productName>
                        <productDescription>description</productDescription>
                        <productCode>code</productCode>
                        <productSKU>sku</productSKU>
                        <productUnitAmount>66</productUnitAmount>
                        <productQuantity>1</productQuantity>
                        <productTaxRate>01</productTaxRate>
                        <productUnitTaxAmount>2</productUnitTaxAmount>
                        <productCategory>category</productCategory>
                        <productTaxCategory>tax</productTaxCategory>
                        <travelData>
                            <numberOfTravelers>3</numberOfTravelers>
                            <travelStartDateTime>2021-03-27</travelStartDateTime>
                            <travelEndDateTime>2021-03-28</travelEndDateTime>
                            <travelReason>reason</travelReason>
                            <travelCardPeriod>period</travelCardPeriod>
                            <travelCardType>cardtype</travelCardType>
                            <PassportDataList>
                                <passportData>
                                    <passportExpirationDate>20210322</passportExpirationDate>
                                    <passportIssueCountry>POL</passportIssueCountry>
                                </passportData>
                            </PassportDataList>
                            <StayDataList>
                                <stayData>
                                    <stayLocation>stayLocation</stayLocation>
                                    <stayArrivalDateTime>2021-03-24</stayArrivalDateTime>
                                    <stayDepartureDateTime>2021-03-23</stayDepartureDateTime>
                                    <numberOfNights>8</numberOfNights>
                                    <numberOfPeopleStaying>9</numberOfPeopleStaying>
                                    <roomServiceLevel>roomServiceLevel</roomServiceLevel>
                                    <stayNumberOfRooms>10</stayNumberOfRooms>
                                    <stayCategory>stayCategory</stayCategory>
                                    <stayCompany>stayCompany</stayCompany>
                                    <stayInsurance>stayInsurance</stayInsurance>
                                    <stayInsuranceIndicator>true</stayInsuranceIndicator>
                                    <stayRentalCarIndicator>true</stayRentalCarIndicator>
                                </stayData>
                            </StayDataList>
                            <JourneyDataList>
                                <journeyData>
                                    <departureLocation>Brazilia</departureLocation>
                                    <arrivalLocation>Sao Polo</arrivalLocation>
                                    <destinationCountry>SRI</destinationCountry>
                                    <departureDateTime>2021-03-26</departureDateTime>
                                    <numberOfTickets>7</numberOfTickets>
                                    <ticketIssuerName>issuerName</ticketIssuerName>
                                    <ticketReference>ticketReference</ticketReference>
                                    <ticketIssueCity>La Paz</ticketIssueCity>
                                    <ticketIssueDate>20210325</ticketIssueDate>
                                    <fareBasis>fareBasis</fareBasis>
                                    <carrierIdentifier>carrierId</carrierIdentifier>
                                    <carrierName>carrierName</carrierName>
                                    <classLevel>class</classLevel>
                                    <journeyModality>modality</journeyModality>
                                    <journeyMode>mode</journeyMode>
                                    <journeyStage>stage</journeyStage>
                                    <journeySequence>sequ</journeySequence>
                                    <journeyInsurance>insurance</journeyInsurance>
                                    <journeyInsuranceIndicator>true</journeyInsuranceIndicator>
                                    <journeyCancellableIndicator>true</journeyCancellableIndicator>
                                    <luggageSupplementIndicator>true</luggageSupplementIndicator>
                                    <ticketExchangeabilityIndicator>true</ticketExchangeabilityIndicator>
                                    <journeyAmount>777</journeyAmount>
                                    <journeyNature>nature</journeyNature>
                                </journeyData>
                            </JourneyDataList>
                            <travelingPayerIndicator>true</travelingPayerIndicator>
                            <bookingData>
                                <bookingPlatform>platform</bookingPlatform>
                                <bookingPlatformOrderId>platformOrderId</bookingPlatformOrderId>
                                <bookingId>bookingId</bookingId>
                                <bookerFirstName>Melody</bookerFirstName>
                                <bookerLastName>Pond</bookerLastName>
                            </bookingData>
                        </travelData>
                    </shoppingCartItem>
                </ShoppingCartItemList>
            </shoppingCartDetail>
            <settlementArchivingReference>settlementArchivingReference</settlementArchivingReference>
            <settlementMerchantSpecificData>settlementMerchantSpecificData</settlementMerchantSpecificData>
        </refund>
	</body>
	<end nbRecord="1" />
</file>

Required

  • 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 Sherlock’s during the shop registration.

  • officeBatchResponseCode
    presence
    Required
    Interface version
    4
    Order
    15

    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 Sherlock’s Office Batch / Merchant not linked to the remitter declared in the header.
  • operationAmount
    presence
    Required
    Interface version
    4
    Order
    4

    Amount of the operation (refund, cancellation, validation etc). The amount must be transmitted in the smallest unit of currency.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • recordSequence
    presence
    Required
    Interface version
    4
    Order
    1

    Transaction order in a Sherlock’s Office Batch file.

Optional

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
REFUND;9;023101122334456;SIM20220329092501;66;978;origin;101;20210329;operationDateTime;transactionDateTime;00;TO_CAPTURE;65;authorisationId;00;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>
		<refund recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <operationAmount>66</operationAmount>
            <currencyCode>978</currencyCode>
            <operationOrigin>origin</operationOrigin>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <operationDateTime>operationDateTime</operationDateTime>
            <transactionDateTime>transactionDateTime</transactionDateTime>
            <responseCode>00</responseCode>
            <newStatus>TO_CAPTURE</newStatus>
            <newAmount>65</newAmount>
            <authorisationId>authorisationId</authorisationId>
            <acquirerResponseCode>00</acquirerResponseCode>
            <officeBatchResponseCode>00</officeBatchResponseCode>
            <shoppingCartDetail>
                <shoppingCartTotalAmount>66</shoppingCartTotalAmount>
                <shoppingCartTotalQuantity>1</shoppingCartTotalQuantity>
                <shoppingCartTotalTaxAmount>2</shoppingCartTotalTaxAmount>
                <mainProduct>main</mainProduct>
                <ShoppingCartItemList>
                    <shoppingCartItem>
                        <productName>name</productName>
                        <productDescription>description</productDescription>
                        <productCode>code</productCode>
                        <productSKU>sku</productSKU>
                        <productUnitAmount>66</productUnitAmount>
                        <productQuantity>1</productQuantity>
                        <productTaxRate>01</productTaxRate>
                        <productUnitTaxAmount>2</productUnitTaxAmount>
                        <productCategory>category</productCategory>
                        <productTaxCategory>tax</productTaxCategory>
                    </shoppingCartItem>
                </ShoppingCartItemList>
            </shoppingCartDetail>
        </refund>
	</body>
	<end nbRecord="1" />
</file>

Changelog


Interface version Data Attendance Container
XML: 20
CSV: 20 		merchantLocationId Request
4 operationOrigin Request/Response
XML: 5
CSV: 5 		s10TransactionReference Request/Response
4 s10TransactionId Container
  • s10TransactionReference
    • 4 s10TransactionIdDate Container
  • s10TransactionReference
    • XML: 13
    CSV: 13     		settlementArchivingReference Request/Response
    XML: 13
    CSV: 13     		settlementMerchantSpecificData Request
    XML: 5 shoppingCartDetail Request/Response
    4 mainProduct Container
  • shoppingCartDetail
    • 4 shoppingCartItemList Container
  • shoppingCartDetail
    • 4 shoppingCartItem Container
  • shoppingCartItemList
    • productName Container
  • shoppingCartItem
    • productUnitTaxAmount Container
  • shoppingCartItem
    • productDescription Container
  • shoppingCartItem
    • productSKU Container
  • shoppingCartItem
    • productQuantity Container
  • shoppingCartItem
    • productTaxRate Container
  • shoppingCartItem
    • productUnitAmount Container
  • shoppingCartItem
    • productCode Container
  • shoppingCartItem
    • productCategory Container
  • shoppingCartItem
    • productTaxCategory Container
  • shoppingCartItem
    • travelData Container
  • shoppingCartItem
    • travelCardPeriod Container
  • travelData
    • journeyDataList Container
  • travelData
    • journeyData Container
  • journeyDataList
    • journeyAmount Container
  • journeyData
    • carrierIdentifier Container
  • journeyData
    • classLevel Container
  • journeyData
    • departureDateTime Container
  • journeyData
    • arrivalLocation Container
  • journeyData
    • destinationCountry Container
  • journeyData
    • fareBasis Container
  • journeyData
    • carrierName Container
  • journeyData
    • journeyCancellableIndicator Container
  • journeyData
    • departureLocation Container
  • journeyData
    • journeyInsurance Container
  • journeyData
    • journeyInsuranceIndicator Container
  • journeyData
    • journeyModality Container
  • journeyData
    • journeyMode Container
  • journeyData
    • journeyNature Container
  • journeyData
    • journeySequence Container
  • journeyData
    • journeyStage Container
  • journeyData
    • luggageSupplementIndicator Container
  • journeyData
    • numberOfTickets Container
  • journeyData
    • ticketExchangeabilityIndicator Container
  • journeyData
    • ticketIssueCity Container
  • journeyData
    • ticketIssueDate Container
  • journeyData
    • ticketIssuerName Container
  • journeyData
    • ticketReference Container
  • journeyData
    • stayDataList Container
  • travelData
    • stayData Container
  • stayDataList
    • stayCategory Container
  • stayData
    • numberOfNights Container
  • stayData
    • stayCompany Container
  • stayData
    • stayArrivalDateTime Container
  • stayData
    • numberOfPeopleStaying Container
  • stayData
    • roomServiceLevel Container
  • stayData
    • stayDepartureDateTime Container
  • stayData
    • stayInsurance Container
  • stayData
    • stayInsuranceIndicator Container
  • stayData
    • stayLocation Container
  • stayData
    • stayNumberOfRooms Container
  • stayData
    • stayRentalCarIndicator Container
  • stayData
    • passportDataList Container
  • travelData
    • passportData Container
  • passportDataList
    • passportExpirationDate Container
  • passportData
    • passportIssueCountry Container
  • passportData
    • mainTravelerFirstName Container
  • travelData
    • travelCardType Container
  • travelData
    • bookingData Container
  • travelData
    • bookerFirstName Container
  • bookingData
    • bookerLastName Container
  • bookingData
    • bookingId Container
  • bookingData
    • bookingPlatform Container
  • bookingData
    • bookingPlatformOrderId Container
  • bookingData
    • mainTravelerLastName Container
  • travelData
    • numberOfTravelers Container
  • travelData
    • travelEndDateTime Container
  • travelData
    • travelingPayerIndicator Container
  • travelData
    • travelReason Container
  • travelData
    • travelStartDateTime Container
  • travelData
    • 4 shoppingCartTotalAmount Container
  • shoppingCartDetail
    • 4 shoppingCartTotalQuantity Container
  • shoppingCartDetail
    • 4 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
    • 4 transactionReference Request/Response
    4 currencyCode Request/Response
    4 merchantId Request/Response
    4 operationAmount Request/Response
    4 recordSequence Request/Response
    4 acquirerResponseCode Response
    4 authorisationId Response
    4 newAmount Response
    4 newStatus Response
    4 operationDateTime Response
    4 responseCode Response
    4 transactionDateTime Response
    4 officeBatchResponseCode Response
    Back to top Need help?

    This site uses trackers to improve your experience, perform analysis and researches on your use of Sherlock's documentation website.
    You have several options:
    Closing this banner you refuse the use of trackers on your device.

    Configuration