Petra2 Java API – SjOrderFacadeInterface.credit

Method description

Kreditera hel beställning eller enstaka beställningsrader. De beställningsrader som berörs och sen tidigare ej är avbokade kommer först att avbokas innan kediteringen genomförs.

Klienter som skickar in ExternalEventSpecification bör ej använda CreditWarning=true. De vill endast spegla ner på beställningen att krediteringen redan är genomförd. Dessa klienter anropar först metoden cancel för att få veta återköpsvärdet innan de själva genomför sin pengatransaktion och denna metod credit genomförs endast på redan avbokade rader.

For Javadoc, click here.

Input

CreditSpecification

ReasonCode - Återköpskod som beskriver skälet till återköpet. Använd värden ifrån SJPConstants.

SJPConstants.VOrderCreditReasonCodeRepurchase - Vanligt återköp. Systemet räknar ut återköpsvärdet.
SJPConstants.VOrderCreditReasonMisstakeAttendance - Felexpediering. Hela tjänstepriset krediteras.

CreditWithWarning: Om flaggan är true kommer krediteringen inte utföras om återköpsvärdet understiger aktuellt pris för någon rad. I dessa fall kommer en CreditWarning att returneras i svaret.
ReasonCode: Om hela beställningen skall krediteras så anges återköpskoden här.
CreditItemSpecificationList: Om ej hela beställningen skall kreditars så anger man här vilka beställningsrader som skall kredietras. Man lägger då återköpskoden i varje CreditItemSpecification.
ExternalPaymentInformation: Innehåller information om krediteringen då klienten redan genomfört pengatransaktionen. T ex då klienten själv kommunicerar direkt mot ett kontokortssystem.
ExternalEventSpecification: Används ifrån externa system där man har en egen varukorg.
ReturnVatDescription: Flagga som avgör om summerade belopp per momssats ska returneras.

CreditSpecification

CreditWithWarning:boolean
{ReasonCode:Code

(beskrivning av ReasonCode)

[CompensationRule:Code]
{CreditItemSpecificationList}, sekvens av:

CreditItemSpecification

OrderItemId:Identity

(beskrivning av OrderItemId)

ReasonCode:Code

(beskrivning av ReasonCode)

[CompensationRule:Code]

[PaynovaReferenceId:String]
[ExternalPaymentInformation:ExternalPaymentInformation]

[CreditCardTransactionJournalData:ByteArray]
[TransactionJournalSpecificationFull:TransactionJournalSpecificationFull]

TransactionResult:String
TerminalID:String
Date:String
Time:String
AccountType:String
MessageType:String
MessageSubtype:String
TransactionCode:String
ApprovalCode:String

(beskrivning av ApprovalCode)

TransactionAmount:String
Currency:String
RetrievalReferenceNumber:String
HandlingCode:String
IdentificationMethod:String
StatusCode:String

(beskrivning av StatusCode)

ResponseCode:String
CardSystem:String

(beskrivning av CardSystem)

ExpiryDate:String
Online:String
[PackageId:String]
[PackageAmount:String]
SequenceNumber:String
OrderId:String

(beskrivning av OrderId)

VAT:String
[purchaseAmount:String]
BundleId:int

(beskrivning av BundleId)

[Cardnr:Identity]

(beskrivning av Cardnr)

[EncryptedCardnumberInfo:EncryptedDataInfo]

EncryptionRoutineId:String
EncryptionRoutineVersion:String
EncryptedData:ByteArray

[PaymentCode:Code]

[ExternalEventSpecification:ExternalEventSpecification]

[SalesUnitId:String]

(beskrivning av SalesUnitId)

[ReturnVatDescription:boolean]

Output

CreditResult

Om en CreditWarning returneras har ingenting krediterats (om man ändå vill kreditera får man göra ett nytt anrop med CreditWithWarning=false).

Om en FailedOrderItemResultList returneras har ingenting krediterats. I listan ser man vilka rader som orsakat detta.

De rader som tidigare inte är avbokade kommer först att avbokas med automatik. Om någon aktuell rad inte kan avbokas syns detta i FailedOrderItemResultList och ingen av de begärda raderna krediteras.

CreditWarning: Ingenting har krediterats eftersom återköpsvärdet understiger aktuellt pris för någon rad. Förutsätter att man angett CreditWithWarning=true i frågan.
FailedOrderItemResultList: De beställningsrader som orsakat att krediteringen ej fullföljs med förklaring. T ex för sent att avboka.
OrderDescription: En beskrivning av hur beställningen ser ut efter krediteringen.
CreditAmount: Totala återköpsvärdet för de rader som krediterats i denna kreditering.
VatDescriptionData: Lista med summerade belopp per momssats för aktuella beställningsrader.