Package com.vonage.client.verify

Class Psd2Request

java.lang.Object

com.vonage.client.verify.BaseRequest

com.vonage.client.verify.Psd2Request

All Implemented Interfaces:

QueryParamsRequest

public class Psd2Request
extends BaseRequest

Describes a PSD2 verify request.

Since:

5.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Psd2Request.Builder
static enum	Psd2Request.Workflow	Enumeration representing different verification workflows.

Method Summary

Modifier and Type	Method	Description
static Psd2Request.Builder	builder()	Entry point for constructing an instance of this class.
static Psd2Request.Builder	builder(String number, Double amount, String payee)	Entry point for constructing an instance of this class, with the required parameters.
Double	getAmount()
String	getPayee()
Psd2Request.Workflow	getWorkflow()
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.
String	toString()

Methods inherited from class com.vonage.client.verify.BaseRequest

getCountry, getDashedLocale, getLength, getLocale, getNextEventWait, getNumber, getPinExpiry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getAmount

public Double getAmount()

Returns:

The decimal amount of the payment to be confirmed, in Euros.

getPayee

public String getPayee()

Returns:

An alphanumeric string to indicate to the user the name of the recipient that they are confirming a payment to.

getWorkflow

public Psd2Request.Workflow getWorkflow()

Returns:

The predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.

builder

public static Psd2Request.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.

Since:

7.9.0

builder

public static Psd2Request.Builder builder(String number,
 Double amount,
 String payee)

Entry point for constructing an instance of this class, with the required parameters.

Parameters:

number - The recipient's phone number in E.164 format.

amount - The decimal amount of the payment to be confirmed, in Euros.

payee - An alphanumeric string to indicate to the user the name of the recipient that they are confirming a payment to.

Returns:

A new Builder to start building.

toString

public String toString()

Overrides:

toString in class BaseRequest

makeParams

public Map<String,String> makeParams()

Description copied from interface: QueryParamsRequest

Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.

Specified by:

makeParams in interface QueryParamsRequest

Overrides:

makeParams in class BaseRequest

Returns:

The query parameters as unique key-value pairs.