Skip to main content

Request Fields

Initial Request (Hosted and Direct Integration)​

These fields should be sent in addition to the basic Request Fields excluding any card details.

Field NameMandatory?Description
paymentMethodYes[1]1Must be the value ‘obmc’ in lower case only
checkoutRedirectURLYes[2]2URL on Merchant’s server to return to when the OBMC Checkout is closed.
checkoutOptionsNoRecord containing options used to customise the OBMC Checkout. Refer to the Checkout Options (Hosted and Direct) section.
obmcCheckoutOptionsNo[3]3Record containing options used to customise the OBMC Checkout. Refer to the Checkout Options (Hosted and Direct) section.

[1] Optional in Hosted Integration.
[2] Not required for Hosted Integration.
[3] Hosted Integration only (instead of checkoutOptions).

Checkout Options​

The following options may be sent in the obmcCheckoutOptions Hosted Integration field or the checkoutOptions Direct Integration field to customise the Checkout. The options must be formatted using the record or serialised record formats detailed in Field Formats.

Option NameDescription
paymentRailWhich underlying payment mechanism should be used, currently the only valid option is UkFasterPayments
clientAssignedReferencePayment reference to assign to this OBMC payment.
context

The payment context. Possible values are:
- BillingGoodsAndServicesInAdvance
- BillingGoodsAndServicesInArrears
- PispPayee
- EcommerceMerchantInitiatedPayment
- FaceToFacePointOfSale
- TransferToSelf
- TransferToThirdParty

endUserThe end user’s details. This field contains sub-fields as detailed below.

The endUser option is used to provide user details to the OBMC Checkout and is a structure
containing the following sub-fields.

Sub-Field NameDescription
idEnd user's id.

The Gateway will validate the checkoutOption fields. If the fields are invalid or mandatory fields are missing, then the transaction will be aborted with a responseCode of 66546 (INVALID CHECKOUTOPTIONS).

Footnotes​

  1. Optional in Hosted Integration ↩

  2. Not required for Hosted Integration. ↩

  3. Hosted Integration only. ↩