Skip to main content

Response Fields

Initial Response (Direct Integration)​

These fields will be returned, in addition to the NomuPay Initial Request Fields and the Basic Response Fields minus any card details.

Field NameMandatory?Desescription
checkoutRefYesUnique checkout session reference.
checkoutNameYes

Unique name of the NomuPay APM Checkout.

Currently uses the value of paymentMethod.

checkoutURLYesURL required to load the NomuPay APM Checkout.
checkoutRequestNoRecord containing any data that must be sent to the NomuPay APM Checkout via a HTTP POST. If not provided, then the Checkout can be loaded via a HTTP GET.
checkoutOptionsNoRecord containing any checkoutOptions passed in the request or added by the Gateway.
checkoutDetailsNoRecord containing additional information provided from NomuPay APM Checkout.
acquirerResponseDetailsNoRecord containing useful details about the NomuPay APM transaction.

Completion Response (Hosted and Direct Integration)​

These fields will be returned, in addition to the Nomupay Initial Request Fields, the NomuPay Initial Response Fields and the Basic Response Fields minus any card details.

Field NameMandatory?Description
checkoutResponseYesContaining additional information provided by the NomuPay APM Checkout. Any change in the payment’s status will be given in the state, responseMessage and responseCode fields[1]1
checkoutStatusNoA string containing the result of the NomuPay APM Checkout process. This is not used to identify the transaction’s payment status.

Footnotes​

  1. Not all payment methods give an immediate payment status. This will require a further QUERY to the Gateway to see whether this value has changed to a status of ‘tendered’. ↩