Direct Implementation
OBMC transactions require you to redirect your Customer’s browser to the OBMC Checkout as part of the transaction flow. The transaction must be done in two stages with the Checkout being displayed between the stages.
OBMC only supports the VERIFY, SALE and REFUND_SALE actions.
Additional information available from OBMC Checkout or the underlying OBMC Acquirer may be made available in the checkoutDetails and acquirerResponseDetails response fields.
The direct integration uses two complex fields to pass data between the OBMC Checkout and the Gateway.
The checkoutRequest field will optionally be provided by the Gateway and is a record whose name/value properties must be sent to the OBMC Checkout, at the provided checkoutURL, via a HTTP POST request. If not provided, then the OBMC Checkout can be opened using a normal
HTTP GET request.
The corresponding checkoutResponse field will be returned by the Gateway and is a record containing name/value properties received from the OBMC Checkout when it redirects the Cardholder’s browser back to the URL provided using the checkoutRedirectURL on completion.
The contents of the checkoutDetails, checkoutRequest, checkoutResponse and acquirerResponseDetails fields are formatted using the record format detailed in Field Formats, the checkoutOptions field also supports being provided using the serialised record format.
Payment Request
To request that a transaction be processed via OBMC the request must contain a paymentMethod of ‘obmc’.
The request must also have a checkoutRedirectURL containing the URL of a page on your server to return to when the OBMC Checkout is closed. In addition, you may send checkoutOptions to provide further custom fields required.
When the Gateway receives these fields, assuming there are no other errors with the request, it will attempt to find a suitable OBMC Merchant Account in the current account routing group as detailed in Merchant Account Routing.
If the Gateway is unable to find a suitable account, then the transaction will be aborted, and it will respond with a responseCode of 66364 (INVALID PAYMENTMETHOD).
Otherwise, the Gateway will respond with a responseCode of 65826 (CHECKOUT REQUIRED) and included in the response will be a checkoutURL field containing the URL of the OBMC Checkout that your Customer’s browser should be redirected to so that the payment may be
completed. The response will also contain a unique checkoutRef which is used by the Gateway to identify this checkout session.
On completion, the OBMC Checkout will redirect the browser to the checkoutRedirectURL you provided, complete with information about the payment in a HTTP POST request. The posted data will contain a checkoutResponse field that will contain any specific response data for the
payment method.