com.nexmo.client.verify

Class Psd2Request.Builder

java.lang.Object

com.nexmo.client.verify.Psd2Request.Builder

Enclosing class:

Psd2Request

public static class Psd2Request.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String number, java.lang.Double amount, java.lang.String payee)

Method Summary

Modifier and Type	Method and Description
Psd2Request	build()
Psd2Request.Builder	country(java.lang.String country) The country for the destination phone number.
Psd2Request.Builder	length(java.lang.Integer length)
Psd2Request.Builder	locale(java.util.Locale locale)
Psd2Request.Builder	nextEventWait(java.lang.Integer nextEventWait)
Psd2Request.Builder	pinExpiry(java.lang.Integer pinExpiry)
Psd2Request.Builder	workflow(Psd2Request.Workflow workflow)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String number,
               java.lang.Double amount,
               java.lang.String payee)

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.

Method Detail

workflow

public Psd2Request.Builder workflow(Psd2Request.Workflow workflow)

Parameters:

workflow - Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user. For example, an id of 1 identifies the workflow SMS - TTS - TTS. For a list of all workflows and their associated ids, please visit the developer portal.

Returns:

Psd2Request.Builder

locale

public Psd2Request.Builder locale(java.util.Locale locale)

Parameters:

locale - (optional) Override the default locale used for verification. By default the locale is determined from the country code included in number

Returns:

Psd2Request.Builder

length

public Psd2Request.Builder length(java.lang.Integer length)

Parameters:

length - (optional) The length of the verification code to be sent to the user. Must be either 4 or 6. Use -1 to use the default value.

Returns:

Psd2Request.Builder

pinExpiry

public Psd2Request.Builder pinExpiry(java.lang.Integer pinExpiry)

Parameters:

pinExpiry - (optional) the PIN validity time from generation, in seconds. Default is 300 seconds

Returns:

Psd2Request.Builder

nextEventWait

public Psd2Request.Builder nextEventWait(java.lang.Integer nextEventWait)

Parameters:

nextEventWait - (optional) the wait time between attempts to deliver the PIN. A number between 600-900.

Returns:

Psd2Request.Builder

country

public Psd2Request.Builder country(java.lang.String country)

The country for the destination phone number.

If you wish to used localised number formats or you are not sure if number is correctly formatted, set this to a two-character country code. For example, GB, US. Verify will work out the international phone number for you.

Parameters:

country - a String containing a 2-character country code

Returns:

Psd2Request.Builder

build

public Psd2Request build()