Checkout mode: Payment Link

POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session

Generates a Payment Link which can be sent to customers in a variety of methods to collect payment through the Hosted Checkout.

Request Body

{"apiOperation"=>"INITIATE_CHECKOUT", "correlationId"=>"correlationId321", "interaction"=>{"operation"=>"PURCHASE", "merchant"=>{"name"=>"TESTMERCHANT", "url"=>"https://uat.arcpay.travel"}}, "order"=>{"amount"=>"100.00", "currency"=>"USD", "id"=>"{{id}}", "description"=>"test order", "invoiceNumber"=>"invoiceNumber1", "reference"=>"{{id}}"}, "checkoutMode"=>"PAYMENT_LINK", "paymentLink"=>{"expiryDateTime"=>"{{expiryDateTime}}", "numberOfAllowedAttempts"=>"10"}, "airline"=>{"bookingReference"=>"bookingref123", "documentType"=>"MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICE", "itinerary"=>{"leg"=>[{"carrierCode"=>"AA", "conjunctionTicketNumber"=>"conjunctionTicke", "stopoverPermitted"=>"true", "departureDate"=>"{{departureDate}}", "travelClass"=>"J", "departureAirport"=>"JFK", "destinationAirport"=>"TPA", "fare"=>"1000.00"}], "numberInParty"=>"001", "originCountry"=>"USA"}, "ticket"=>{"ticketNumber"=>"123456789101", "issue"=>{"carrierCode"=>"AA", "carrierName"=>"AmericanAirlines", "travelAgentCode"=>"12345678", "travelAgentName"=>"AcmeTravel"}}, "passenger"=>{"firstName"=>"passfirstname", "lastName"=>"passlastname", "middleName"=>"passmiddlename", "specificInformation"=>"passspecificinfo123", "title"=>"passtitle"}, "planNumber"=>"1A"}}

RESPONSES

status: Created

{"checkoutMode":"PAYMENT_LINK","correlationId":"correlationId321","merchant":"merchantId","paymentLink":{"expiryDateTime":"2023-06-15T21:39:43.954Z","id":"PAYLINK0001434272687F8776735M09","numberOfAllowedAttempts":10,"url":"https://api.arcpay.travel/pbl/PAYLINK0001434272687F8776735M09"},"result":"SUCCESS","successIndicator":"7ad561947edd4c03"}