Package com.checkout.forward.requests

Class ForwardRequest

java.lang.Object

com.checkout.forward.requests.ForwardRequest

public final class ForwardRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForwardRequest.ForwardRequestBuilder

Constructor Summary

Constructors

Constructor	Description
ForwardRequest()
ForwardRequest(AbstractSource source, DestinationRequest destinationRequest, java.lang.String reference, java.lang.String processingChannelId, NetworkToken networkToken)	Creates a new ForwardRequest instance.

Method Summary

Modifier and Type	Method	Description
static ForwardRequest.ForwardRequestBuilder	builder()
boolean	equals(java.lang.Object o)
DestinationRequest	getDestinationRequest()	The parameters of the forward request (Required)
NetworkToken	getNetworkToken()	Specifies if and how a network token should be used in the forward request.
java.lang.String	getProcessingChannelId()	The processing channel ID to associate the billing for the forward request with (Optional, pattern ^(pc)_(\w{26})$)
java.lang.String	getReference()	Unique reference for the forward request.
AbstractSource	getSource()	The payment source to enrich the forward request with.
int	hashCode()
void	setDestinationRequest(DestinationRequest destinationRequest)	The parameters of the forward request (Required)
void	setNetworkToken(NetworkToken networkToken)	Specifies if and how a network token should be used in the forward request.
void	setProcessingChannelId(java.lang.String processingChannelId)	The processing channel ID to associate the billing for the forward request with (Optional, pattern ^(pc)_(\w{26})$)
void	setReference(java.lang.String reference)	Unique reference for the forward request.
void	setSource(AbstractSource source)	The payment source to enrich the forward request with.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ForwardRequest

public ForwardRequest()

ForwardRequest

public ForwardRequest(AbstractSource source,
                      DestinationRequest destinationRequest,
                      java.lang.String reference,
                      java.lang.String processingChannelId,
                      NetworkToken networkToken)

Creates a new ForwardRequest instance.

Parameters:

source - The payment source to enrich the forward request with. You can provide placeholder values in destination_request.body. The request will be enriched with the respective payment credentials from the token or payment instrument you specified. For example, {{card_number}} (Required)

destinationRequest - The parameters of the forward request (Required)

reference - Unique reference for the forward request. (Optional, max 80 characters)

processingChannelId - The processing channel ID to associate the billing for the forward request with (Optional, pattern ^(pc)_(\w{26})$)

networkToken - Specifies if and how a network token should be used in the forward request. (Optional)

Method Detail

builder

public static ForwardRequest.ForwardRequestBuilder builder()

getSource

public AbstractSource getSource()

The payment source to enrich the forward request with. You can provide placeholder values in destination_request.body. The request will be enriched with the respective payment credentials from the token or payment instrument you specified. For example, {{card_number}} (Required)

getDestinationRequest

public DestinationRequest getDestinationRequest()

The parameters of the forward request (Required)

getReference

public java.lang.String getReference()

Unique reference for the forward request. (Optional, max 80 characters)

getProcessingChannelId

public java.lang.String getProcessingChannelId()

The processing channel ID to associate the billing for the forward request with (Optional, pattern ^(pc)_(\w{26})$)

getNetworkToken

public NetworkToken getNetworkToken()

Specifies if and how a network token should be used in the forward request. (Optional)

setSource

public void setSource(AbstractSource source)

The payment source to enrich the forward request with. You can provide placeholder values in destination_request.body. The request will be enriched with the respective payment credentials from the token or payment instrument you specified. For example, {{card_number}} (Required)

setDestinationRequest

public void setDestinationRequest(DestinationRequest destinationRequest)

The parameters of the forward request (Required)

setReference

public void setReference(java.lang.String reference)

Unique reference for the forward request. (Optional, max 80 characters)

setProcessingChannelId

public void setProcessingChannelId(java.lang.String processingChannelId)

The processing channel ID to associate the billing for the forward request with (Optional, pattern ^(pc)_(\w{26})$)

setNetworkToken

public void setNetworkToken(NetworkToken networkToken)

Specifies if and how a network token should be used in the forward request. (Optional)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object