Tokenize

amount

true

Int

The payment amount is in minor units to charge the customer's card. Use the correct minor units amount for the merchant account currency.

For example, to process US $10.99, this value should be 1099. To process 1000 Japanese Yen, this value should be 1000. To process 10.139 Tunisian dinar, this value should be 10139.

Min = 1

Max = 999999999

currencyCode

true

String

The currencyCode accepts 3 letter abbreviations of the ISO standard currencies.

accountId

conditional

String

The id of the selected merchant account to use to process the payment.

If you are a merchant, then this field is required only if you have more than one account configured for the same payment method and currency. If you are a partner using a shared API key, then this field is mandatory.

transactionType

true

TransactionType

This specifies the transaction type for which the Payment Handle is created. Possible values are:

• PAYMENT - Payment Handle is created to continue the Payment.
• STANDALONE_CREDIT - Payment Handle is created to continue the standalone credit.
• ORIGINAL_CREDIT - Payment Handle is created to continue the original credit.
• VERIFICATION - Payment Handle is created to continue the verification request.

merchantRefNum

true

String

A unique identifier is provided by the merchant for every transaction in Paysafe Android SDK.

billingDetails

false

BillingDetails

Card billing address - additional details for the billingDetails object can be found in the Payments API documentation.

profile

false

Profile

This is the profile of the customer - additional details for the profile object can be found in the Payments API documentation.

merchantDescriptor

false

MerchantDescriptor

This is a merchant descriptor that is displayed on a customer’s card statement.

singleUseCustomerToken

false

String

This is the singleUseCustomerToken that the merchant generated using the Create a Single-Use Customer Token request.

Specify this parameter when you want to use a saved card.

paymentTokenFrom

false

String

This is single-use payment handle associated with the customer.

Specify this parameter when you want to use a saved card.

renderType

false

RenderType

Specify the render type that the device supports for displaying specific challenge user interfaces within the SDK.

The list of all the render types:

• NATIVE
• HTML
• BOTH

country

true

String

Country of billing address

zip

true

String

Zip code of the address

state

false

String

State/province/region of the address

city

false

String

City in which the address is located

street

false

String

The first line of the street address

street2

false

String

The second line of the street address

phone

false

String

The phone number of the customer

nickname

false

String

The nickname of the customer

firstName

false

String

This is the customer’s first name.

lastName

false

String

This is the customer’s last name.

email

false

String

This is the customer’s email address.

phone

false

String

This is the customer’s phone number.

dynamicDescriptor

true

String

This is a merchant descriptor that is displayed on a customer’s card statement

phone

false

String

This is the merchant’s phone number, which is appended to the merchant descriptor on a customer’s card statement.

createdDate

false

String

This is the date that the cardholder opened the account with the 3DS Requestor. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.

createdRange

false

CreatedRange

This indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.

CreatedRange is an enum with the following cases:

• DURING_TRANSACTION
• NO_ACCOUNT
• LESS_THAN_THIRTY_DAYS
• THIRTY_TO_SIXTY_DAYS
• MORE_THAN_SIXTY_DAYS

data

false

String

This field is reserved for future iterations of 3D Secure 2.

length <= 2048 chars

method

false

ThreeDSAuthentication

This is the mechanism used previously by the cardholder to authenticate to the 3DS Requestor. Possible values are:

• frictionlessAuthentication
• acsChallenge
• avsVerified
• otherIssuerMethod

id

false

String

This is a previous authentication ID for the cardholder.

length <= 36 chars

time

false

String

This is the date and time of the cardholder authentication. The ISO 8601 date format is expected, i.e., YYYY-MM-DD-THH:MM:SSZ.

isAirTravel

false

Boolean

This indicates whether the transaction is an air travel related purchase, e.g., a ticket purchase.

If omitted, defaults to false.

airlineCarrier

conditional

String

This is the selected airline carrier.

Note: This element is required only if isAirTravel=true.

length <= 256 chars

departureDate

conditional

String

This is the date of departure in the time zone of the departure location. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.

Note: This element is required only if isAirTravel=true.

destination

conditional

String

This is the airport code of the destination airport.

Note: This element is required only if isAirTravel=true.

length <= 5 chars

origin

conditional

String

This is the airport code of the originating airport.

Note: This element is required only if isAirTravel=true.

length <= 5 chars

passengerFirstName

conditional

String

This is the first name of the cardholder from the billing details.

Note: This element is required only if isAirTravel=true.

length <= 99 chars

passengerLastName

conditional

String

This is the last name of the cardholder from the billing details.

Note: This element is required only if isAirTravel=true.

length <= 99 chars