Skip to content

Integrating with APEXX

Jonathan Beverley edited this page Mar 4, 2022 · 3 revisions

Before starting

Before starting to integrate a website with APEXX, there are some important steps to complete first.

  1. Read documentation provided by APEXX. Specifically the "Transaction - Hosted" section is most likely to be used: https://sandmgw.apexxfintech.com/mgw/v2/api/doc

  2. Request Sandbox Account Ids and API Keys from [email protected]

Overview

This documentation was written as a guide to help integrate a website with APEXX Hosted Transactions. The mechanism relies on several actions from the initiating website.

  1. Initialise an inframe by posting the transaction registration request to APEXX. See APEXX documentation for more details https://sandmgw.apexxfintech.com/mgw/v2/api/doc#tag/Transaction-Hosted .

  2. The transaction request will include a return_url which APEXX will redirect the customer to on completion.

  3. If you are taking DEFERRED payments you must set capture_now to false on the transaction registration.

  4. Once you receive the completion payload from APEXX you must POST it to the /booking/{bookingId}/payment endpoint.

    { "reason_code" : "string", "merchant_reference" : "string", "_id" : "string", "status" : "CAPTURED", "token" : "string", "created_at" : "string", "card_number" : "string", "expiry_month" : "string", "expiry_year" : "string", "card_scheme" : "string", "signature" : "string" }

Clone this wiki locally