CreateHostedCheckoutResponse (onlinepayments-sdk-java 4.18.0 API)

java.lang.Object
- com.onlinepayments.domain.CreateHostedCheckoutResponse

public class CreateHostedCheckoutResponse
extends Object

Constructor Summary

Constructors
Constructor and Description

CreateHostedCheckoutResponse()

Constructors
Constructor and Description
`CreateHostedCheckoutResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getHostedCheckoutId()` The ID of the Hosted Checkout Session in which the payment was made.
`List<String>`	`getInvalidTokens()` Tokens that are submitted in the request are validated.
`String`	`getMerchantReference()` Your unique reference of the transaction that is also returned in our report files.
`String`	`getPartialRedirectUrl()` The partial URL as generated by our system.
`String`	`getRedirectUrl()` The full hosted checkout URL as generated by our system.
`String`	`getRETURNMAC()` When the customer is returned to your site we will append this property and value to the query-string.
`void`	`setHostedCheckoutId(String value)` The ID of the Hosted Checkout Session in which the payment was made.
`void`	`setInvalidTokens(List<String> value)` Tokens that are submitted in the request are validated.
`void`	`setMerchantReference(String value)` Your unique reference of the transaction that is also returned in our report files.
`void`	`setPartialRedirectUrl(String value)` The partial URL as generated by our system.
`void`	`setRedirectUrl(String value)` The full hosted checkout URL as generated by our system.
`void`	`setRETURNMAC(String value)` When the customer is returned to your site we will append this property and value to the query-string.
`CreateHostedCheckoutResponse`	`withHostedCheckoutId(String value)` The ID of the Hosted Checkout Session in which the payment was made.
`CreateHostedCheckoutResponse`	`withInvalidTokens(List<String> value)` Tokens that are submitted in the request are validated.
`CreateHostedCheckoutResponse`	`withMerchantReference(String value)` Your unique reference of the transaction that is also returned in our report files.
`CreateHostedCheckoutResponse`	`withPartialRedirectUrl(String value)` The partial URL as generated by our system.
`CreateHostedCheckoutResponse`	`withRedirectUrl(String value)` The full hosted checkout URL as generated by our system.
`CreateHostedCheckoutResponse`	`withRETURNMAC(String value)` When the customer is returned to your site we will append this property and value to the query-string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateHostedCheckoutResponse
```
public CreateHostedCheckoutResponse()
```
- Method Detail
  - getRETURNMAC
```
public String getRETURNMAC()
```
    When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
  - setRETURNMAC
```
public void setRETURNMAC(String value)
```
    When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
  - withRETURNMAC
```
public CreateHostedCheckoutResponse withRETURNMAC(String value)
```
    When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
  - getHostedCheckoutId
```
public String getHostedCheckoutId()
```
    The ID of the Hosted Checkout Session in which the payment was made.
  - setHostedCheckoutId
```
public void setHostedCheckoutId(String value)
```
    The ID of the Hosted Checkout Session in which the payment was made.
  - withHostedCheckoutId
```
public CreateHostedCheckoutResponse withHostedCheckoutId(String value)
```
    The ID of the Hosted Checkout Session in which the payment was made.
  - getInvalidTokens
```
public List<String> getInvalidTokens()
```
    Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
  - setInvalidTokens
```
public void setInvalidTokens(List<String> value)
```
    Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
  - withInvalidTokens
```
public CreateHostedCheckoutResponse withInvalidTokens(List<String> value)
```
    Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
  - getMerchantReference
```
public String getMerchantReference()
```
    Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
  - setMerchantReference
```
public void setMerchantReference(String value)
```
    Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
  - withMerchantReference
```
public CreateHostedCheckoutResponse withMerchantReference(String value)
```
    Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
  - getPartialRedirectUrl
```
public String getPartialRedirectUrl()
```
    The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your hosted pages.
  - setPartialRedirectUrl
```
public void setPartialRedirectUrl(String value)
```
    The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your hosted pages.
  - withPartialRedirectUrl
```
public CreateHostedCheckoutResponse withPartialRedirectUrl(String value)
```
    The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your hosted pages.
  - getRedirectUrl
```
public String getRedirectUrl()
```
    The full hosted checkout URL as generated by our system. Use this URL to redirect your customer to the hosted checkout page.
  - setRedirectUrl
```
public void setRedirectUrl(String value)
```
    The full hosted checkout URL as generated by our system. Use this URL to redirect your customer to the hosted checkout page.
  - withRedirectUrl
```
public CreateHostedCheckoutResponse withRedirectUrl(String value)
```
    The full hosted checkout URL as generated by our system. Use this URL to redirect your customer to the hosted checkout page.

Class CreateHostedCheckoutResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateHostedCheckoutResponse

Method Detail

getRETURNMAC

setRETURNMAC

withRETURNMAC

getHostedCheckoutId

setHostedCheckoutId

withHostedCheckoutId

getInvalidTokens

setInvalidTokens

withInvalidTokens

getMerchantReference

setMerchantReference

withMerchantReference

getPartialRedirectUrl

setPartialRedirectUrl

withPartialRedirectUrl

getRedirectUrl

setRedirectUrl

withRedirectUrl