Operation 2: Refund

PUT https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/order/{{orderIdForRefund}}/transaction/{{refundTransactionId}}

Create a refund for the exact amount of the payment.

Request Body

{"apiOperation"=>"REFUND", "airline"=>{"documentType"=>"AGENCY_MISCELLANEOUS_CHARGE_ORDER", "bookingReference"=>"987654321", "passenger"=>[{"firstName"=>"TEST", "lastName"=>"TESTER"}], "itinerary"=>{"leg"=>[{"departureDate"=>"2023-02-01"}]}, "ticket"=>{"ticketNumber"=>"0812321241212", "issue"=>{"city"=>"Tampa", "date"=>"2023-01-11", "country"=>"USA", "travelAgentCode"=>"12345678", "travelAgentName"=>"AcmeTravel"}}}, "transaction"=>{"reference"=>"{{refundTransactionId}}", "amount"=>"100.20", "currency"=>"USD"}, "posTerminal"=>{"inputCapability"=>"KEY_ENTRY", "panEntryMode"=>"ECOMMERCE", "lane"=>"KIOSK_76"}}

RESPONSES

status: Created

{"airline":{"documentType":"AGENCY_MISCELLANEOUS_CHARGE_ORDER","bookingReference":"987654321","passenger":[{"firstName":"TEST","lastName":"TESTER"}],"itinerary":{"leg":[{"departureDate":"2023-02-01"}]},"ticket":{"ticketNumber":"0812321241212","issue":{"city":"Tampa","date":"2023-01-11","country":"USA","travelAgentCode":"12345678","travelAgentName":"AcmeTravel"}}},"authorizationResponse":{"cardSecurityCodeError":"M","commercialCard":"888","commercialCardIndicator":"3","financialNetworkCode":"777","posData":"0001100000600","posEntryMode":"012","processingCode":"203000","responseCode":"00","stan":"4184","transactionIdentifier":"123456789"},"gatewayEntryPoint":"WEB_SERVICES_API","merchant":"merchantId","order":{"amount":100.2,"chargeback":{"amount":0,"currency":"USD"},"creationTime":"2023-03-16T21:39:55.521Z","currency":"USD","id":"47d8e415-a8b6-4e5c-bf98-9062ab71dcf7","lastUpdatedTime":"2023-03-16T21:40:16.706Z","merchantAmount":100.2,"merchantCategoryCode":"4511","merchantCurrency":"USD","reference":"47d8e415-a8b6-4e5c-bf98-9062ab71dcf7","status":"REFUNDED","totalAuthorizedAmount":100.2,"totalCapturedAmount":100.2,"totalDisbursedAmount":0,"totalRefundedAmount":100.2},"response":{"acquirerCode":"00","cardSecurityCode":{"acquirerCode":"M","gatewayCode":"MATCH"},"gatewayCode":"APPROVED"},"result":"SUCCESS","sourceOfFunds":{"provided":{"card":{"brand":"MASTERCARD","expiry":{"month":"1","year":"39"},"fundingMethod":"CREDIT","issuer":"AFRILAND FIRST BANK","number":"512345xxxxxx0008","scheme":"MASTERCARD","storedOnFile":"NOT_STORED"}},"type":"CARD"},"timeOfLastUpdate":"2023-03-16T21:40:16.706Z","timeOfRecord":"2023-03-16T21:40:16.676Z","transaction":{"acquirer":{"batch":20230316,"date":"0316","id":"ARC_S2I","merchantId":"00090000266","settlementDate":"2023-03-16","timeZone":"-0400","transactionId":"123456789"},"amount":100.2,"currency":"USD","id":"6b961519-65e2-4846-abb1-39cdf78628ab","receipt":"307521005194","reference":"6b961519-65e2-4846-abb1-39cdf78628ab","source":"MOTO","stan":"5194","terminal":"0001","type":"REFUND"},"version":"70"}