Release 24.5

aller directement au contenu

Rechercher par mots clés

refund (batch)

Pour rechercher dans la page utiliser Ctrl+F sur votre clavier

Cette opération vous permet de rembourser une transaction en créditant le compte du client et en débitant votre compte.

Obligatoire

  • currencyCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    5

    Code de la devise de la transaction. Ce code est compatible ISO 4217.

    Liste des valeurs
    032
    Peso argentin
    036
    Dollar australien
    048
    Dinar de Bahreïn
    116
    Riel cambodgien
    124
    Dollar canadien
    144
    Roupie sri lankaise
    156
    Yuan Renminbi
    191
    Kuna croate
    203
    Couronne tchèque
    208
    Couronne danoise
    344
    Dollar de Hong Kong
    348
    Forint hongrois
    352
    Couronne islandaise
    356
    Roupie indienne
    376
    Nouveau Shekel israélien
    392
    Yen japonais
    410
    Won coréen
    414
    Dinar koweïtien
    458
    Ringgit malaisien
    480
    Roupie de Maurice
    484
    Peso mexicain
    524
    Roupie népalaise
    554
    Dollar néo-zélandais
    578
    Couronne norvégienne
    634
    Rial qatari
    643
    Rouble russe
    682
    Riyal saoudien
    702
    Dollar de Singapour
    710
    Rand sud-africain
    752
    Couronne suédoise
    756
    Franc suisse
    764
    Baht thaïlandais
    784
    Dirham des Émirats arabes unis
    788
    Dinar tunisien
    826
    Livre Sterling
    840
    Dollar américain
    901
    Dollar de Taiwan
    941
    Dinar serbe
    946
    Leu roumain
    949
    Nouvelle livre turque
    952
    Franc CFA
    953
    Franc Pacifique
    975
    Lev bulgare
    978
    Euro
    980
    Hryvnia ukrainien
    985
    Zloty polonaise
    986
    Real brésilien
  • merchantId
    présence
    Obligatoire
    Interface version
    4
    Ordre
    2

    Identifiant de la boutique, sa valeur est fournie par Sherlock’s au commerçant lors de l’inscription de sa boutique.

  • operationAmount
    présence
    Obligatoire
    Interface version
    4
    Ordre
    4

    Montant de l’opération (remboursement, annulation, validation …). Le montant doit être transmis dans la plus petite unité de la devise.Exemple pour l’Euro : un montant de 10,50 Euros doit être transmis sous la forme 1050.

  • recordSequence
    présence
    Obligatoire
    Interface version
    4
    Ordre
    1

    Ordre d’une transaction dans un fichier Sherlock’s Office Batch.

Optionnel

Exemple de requête

            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>

Obligatoire

  • currencyCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    5

    Code de la devise de la transaction. Ce code est compatible ISO 4217.

    Liste des valeurs
    032
    Peso argentin
    036
    Dollar australien
    048
    Dinar de Bahreïn
    116
    Riel cambodgien
    124
    Dollar canadien
    144
    Roupie sri lankaise
    156
    Yuan Renminbi
    191
    Kuna croate
    203
    Couronne tchèque
    208
    Couronne danoise
    344
    Dollar de Hong Kong
    348
    Forint hongrois
    352
    Couronne islandaise
    356
    Roupie indienne
    376
    Nouveau Shekel israélien
    392
    Yen japonais
    410
    Won coréen
    414
    Dinar koweïtien
    458
    Ringgit malaisien
    480
    Roupie de Maurice
    484
    Peso mexicain
    524
    Roupie népalaise
    554
    Dollar néo-zélandais
    578
    Couronne norvégienne
    634
    Rial qatari
    643
    Rouble russe
    682
    Riyal saoudien
    702
    Dollar de Singapour
    710
    Rand sud-africain
    752
    Couronne suédoise
    756
    Franc suisse
    764
    Baht thaïlandais
    784
    Dirham des Émirats arabes unis
    788
    Dinar tunisien
    826
    Livre Sterling
    840
    Dollar américain
    901
    Dollar de Taiwan
    941
    Dinar serbe
    946
    Leu roumain
    949
    Nouvelle livre turque
    952
    Franc CFA
    953
    Franc Pacifique
    975
    Lev bulgare
    978
    Euro
    980
    Hryvnia ukrainien
    985
    Zloty polonaise
    986
    Real brésilien
  • merchantId
    présence
    Obligatoire
    Interface version
    4
    Ordre
    2

    Identifiant de la boutique, sa valeur est fournie par Sherlock’s au commerçant lors de l’inscription de sa boutique.

  • officeBatchResponseCode
    présence
    Obligatoire
    Interface version
    4
    Ordre
    15

    officeBatchResponseCode complète le résultat du traitement d’une demande de paiement traitée par Sherlock’s Office Batch qui serait rejetée (code de réponse classique de rejet) et contient le champ de la demande de paiement en erreur.

    Liste des valeurs
    00
    Aucun (tous les champs sont corrects).
    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
    Commerçant non enregistré pour Sherlock’s Office Batch /non lié au remettant déclaré dans l’en-tête.
  • operationAmount
    présence
    Obligatoire
    Interface version
    4
    Ordre
    4

    Montant de l’opération (remboursement, annulation, validation …). Le montant doit être transmis dans la plus petite unité de la devise.Exemple pour l’Euro : un montant de 10,50 Euros doit être transmis sous la forme 1050.

  • recordSequence
    présence
    Obligatoire
    Interface version
    4
    Ordre
    1

    Ordre d’une transaction dans un fichier Sherlock’s Office Batch.

Optionnel

Exemple de réponse

            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 Donnée Présence Conteneur
XML: 20
CSV: 20 		merchantLocationId Requête
4 operationOrigin Requête/Réponse
XML: 5
CSV: 5 		s10TransactionReference Requête/Réponse
4 s10TransactionId Conteneur
  • s10TransactionReference
    • 4 s10TransactionIdDate Conteneur
  • s10TransactionReference
    • XML: 13
    CSV: 13     		settlementArchivingReference Requête/Réponse
    XML: 13
    CSV: 13     		settlementMerchantSpecificData Requête
    XML: 5 shoppingCartDetail Requête/Réponse
    4 mainProduct Conteneur
  • shoppingCartDetail
    • 4 shoppingCartItemList Conteneur
  • shoppingCartDetail
    • 4 shoppingCartItem Conteneur
  • shoppingCartItemList
    • productName Conteneur
  • shoppingCartItem
    • productUnitTaxAmount Conteneur
  • shoppingCartItem
    • productDescription Conteneur
  • shoppingCartItem
    • productSKU Conteneur
  • shoppingCartItem
    • productQuantity Conteneur
  • shoppingCartItem
    • productTaxRate Conteneur
  • shoppingCartItem
    • productUnitAmount Conteneur
  • shoppingCartItem
    • productCode Conteneur
  • shoppingCartItem
    • productCategory Conteneur
  • shoppingCartItem
    • productTaxCategory Conteneur
  • shoppingCartItem
    • travelData Conteneur
  • shoppingCartItem
    • travelCardPeriod Conteneur
  • travelData
    • journeyDataList Conteneur
  • travelData
    • journeyData Conteneur
  • journeyDataList
    • journeyAmount Conteneur
  • journeyData
    • carrierIdentifier Conteneur
  • journeyData
    • classLevel Conteneur
  • journeyData
    • departureDateTime Conteneur
  • journeyData
    • arrivalLocation Conteneur
  • journeyData
    • destinationCountry Conteneur
  • journeyData
    • fareBasis Conteneur
  • journeyData
    • carrierName Conteneur
  • journeyData
    • journeyCancellableIndicator Conteneur
  • journeyData
    • departureLocation Conteneur
  • journeyData
    • journeyInsurance Conteneur
  • journeyData
    • journeyInsuranceIndicator Conteneur
  • journeyData
    • journeyModality Conteneur
  • journeyData
    • journeyMode Conteneur
  • journeyData
    • journeyNature Conteneur
  • journeyData
    • journeySequence Conteneur
  • journeyData
    • journeyStage Conteneur
  • journeyData
    • luggageSupplementIndicator Conteneur
  • journeyData
    • numberOfTickets Conteneur
  • journeyData
    • ticketExchangeabilityIndicator Conteneur
  • journeyData
    • ticketIssueCity Conteneur
  • journeyData
    • ticketIssueDate Conteneur
  • journeyData
    • ticketIssuerName Conteneur
  • journeyData
    • ticketReference Conteneur
  • journeyData
    • stayDataList Conteneur
  • travelData
    • stayData Conteneur
  • stayDataList
    • stayCategory Conteneur
  • stayData
    • numberOfNights Conteneur
  • stayData
    • stayCompany Conteneur
  • stayData
    • stayArrivalDateTime Conteneur
  • stayData
    • numberOfPeopleStaying Conteneur
  • stayData
    • roomServiceLevel Conteneur
  • stayData
    • stayDepartureDateTime Conteneur
  • stayData
    • stayInsurance Conteneur
  • stayData
    • stayInsuranceIndicator Conteneur
  • stayData
    • stayLocation Conteneur
  • stayData
    • stayNumberOfRooms Conteneur
  • stayData
    • stayRentalCarIndicator Conteneur
  • stayData
    • passportDataList Conteneur
  • travelData
    • passportData Conteneur
  • passportDataList
    • passportExpirationDate Conteneur
  • passportData
    • passportIssueCountry Conteneur
  • passportData
    • mainTravelerFirstName Conteneur
  • travelData
    • travelCardType Conteneur
  • travelData
    • bookingData Conteneur
  • travelData
    • bookerFirstName Conteneur
  • bookingData
    • bookerLastName Conteneur
  • bookingData
    • bookingId Conteneur
  • bookingData
    • bookingPlatform Conteneur
  • bookingData
    • bookingPlatformOrderId Conteneur
  • bookingData
    • mainTravelerLastName Conteneur
  • travelData
    • numberOfTravelers Conteneur
  • travelData
    • travelEndDateTime Conteneur
  • travelData
    • travelingPayerIndicator Conteneur
  • travelData
    • travelReason Conteneur
  • travelData
    • travelStartDateTime Conteneur
  • travelData
    • 4 shoppingCartTotalAmount Conteneur
  • shoppingCartDetail
    • 4 shoppingCartTotalQuantity Conteneur
  • shoppingCartDetail
    • 4 shoppingCartTotalTaxAmount Conteneur
  • shoppingCartDetail
    • 4 transactionReference Requête/Réponse
    4 currencyCode Requête/Réponse
    4 merchantId Requête/Réponse
    4 operationAmount Requête/Réponse
    4 recordSequence Requête/Réponse
    4 acquirerResponseCode Réponse
    4 authorisationId Réponse
    4 newAmount Réponse
    4 newStatus Réponse
    4 operationDateTime Réponse
    4 responseCode Réponse
    4 transactionDateTime Réponse
    4 officeBatchResponseCode Réponse
    Retourner en haut de page Besoin d'aide ?

    Besoin d'aide ?

    Contacter le support
    Fermer

    Ce site utilise des traceurs pour améliorer votre expérience de navigation, effectuer des analyses et des recherches sur votre utilisation du site web de documentation Sherlock's.
    En fermant ce bandeau vous refusez notre utilisation des traceurs sur votre appareil.

    Paramètres