Skip to main content

Response Fields

Initial Response (Direct Integration)​

These fields will be returned, in addition to the request fields from Initial Request and the basic response fields in Response Fields minus any card details.

Field NameMandatory
checkoutRefYesUnique checkout session reference.
checkoutNameNo[1]1Unique name of the OBMC Checkout. Currently uses the value of paymentMethod.
checkoutURLYesURL required to load the OBMC Checkout.
checkoutRequestNoRecord containing any data that must be sent to the OBMC Checkout via a HTTP POST. If not provided, then the Checkout can be loaded via a HTTP GET.
checkoutDetailsNo[1]1Record containing values made available by the OBMC Checkout.
acquirerResponseDetailsNoRecord containing useful details about the OBMC transaction.

[1] This field is currently not supported by OBMC but is reserved for future use.

Completion Response (Hosted and Direct Integration)​

These fields will be returned, in addition to the request fields from Initial Request, the Initial Response fields and the basic response fields in Response Fields minus any card details.

Field NameMandatoryDescription
checkoutResponseYesContaining additional information provided by the OBMC Checkout. Any change in the payment’s status will be given in responseMessage and responseCode[1]2
checkoutStatusYesA string containing the result of the OBMC Checkout process. This is not used to identify the transaction’s payment status.

[1] Not all payments give an immediate payment status. This will require a further QUERY to the Gateway to see whether their status has changed.

Footnotes​

  1. This field is currently not supported by OBMC but is reserved for future use. ↩ ↩2

  2. Not all payments give an immediate payment status. This will require a further QUERY to the Gateway to see whether their status has changed. ↩