Pay-me SDK iOS input and output parameters

Parameter

Type

Required

Description

setting

PaymeSettingData object

Yes

Contains the behavioral settings values of the payment form.

purchase

PaymePurchaseData object

Yes

Contains purchase information

feature

PaymeFeatureData object

No

Additional features during the transaction.

Parameter

Type

Length

Required

Description

locale

String

5

Yes

Localization of the language the form will be displayed in.

Value - Description

es_PE Español Perú

brands

Array<String>

4

Yes

Contains the values of the marks that will be enabled for the payment form.

Value - Description

VISA Visa

MSCD MasterCard

AMEX American Express

DINC Diners Club

Parameter

Type

Required

Description

operation

PaymeOperationData object

Yes

Contains the data of the operation with which the transaction will be processed.

addrMatch

Boolean

No

Field indicating whether the shipping address will be the same as the billing address.

billing

PaymePersonData object

Yes

Purchase order billing data information.

shipping

PaymePersonData object

No

Purchase order shipment data information.

Parameter

Type

Length

Required

Description

operationNumber

String

6

Yes

Unique transaction number in the gateway, which will be used to perform the transaction.

operationDescription

String

30

Yes

Description of the product for which the transaction is made.

amount

String

11

Yes

Amount to be charged by the payment gateway, it must be considered point as decimal separator and a maximum of two decimal digits (0.00).

currency

PaymeCurrencyData object

-

Yes

Information of the currency in which the transaction will be made.

Parameter

Type

Length

Required

Description

code

String

3

Yes

Currency code ISO-4217.

symbol

String

5

Yes

Currency symbol with which the amount will be displayed on the form has no effect on the transaction. The use of the symbols determined in ISO-4217 is recommended.

Parameter

Type

Length

Required

Description

firstName

String

30

Yes

Name

lastName

String

50

Yes

Surname

email

String

50

Yes

E-mail address

addrLine1

String

50

Yes

Address

addrLine2

String

50

No

Address

countryCode

String

2

Yes

Country Code in letter. ISO-3166

countryNumber

String

3

Yes

Country code in number. ISO-3166

zip

String

10

Yes

Postal Code

city

String

50

Yes

City/Province

state

String

15

Yes

State/Department

mobilePhone

String

15

Yes

Cardholder's country code and cell phone number (51-958435685)

homePhone

String

15

No

Country code and cardholder's home phone number (51-958435685)

workPhone

String

15

No

Cardholder's country code and work phone number (51-958435685)

Parameter

Type

Required

Description

reserved

Dictionary

No

Contains the behavioral settings values for the reserved data coming from the trade.

wallet

PaymeWalletData object

No

Contains the behavioral setting values for activating Wallet.

installments

PaymeInstallmentsData object

No

Contains the behavioral setting values for activating Plans and Fees.

authentication

PaymeAuthenticationData object

No

Contains the values of authentication behavior settings.

Parameter

Type

Length

Required

Description

enable

Boolean

-

No

Field to activate the use of wallet. Remember that the merchant must have enabled the wallet functionality in the service configurator.

userID

String

30

No

Value to identify a user's wallet. It is mandatory when the enable parameter is true.

Parameter

Type

Required

Description

enable

Boolean

No

Field to activate the use of plans and quotas. Remember that the merchant must have enabled the installments functionality in the configurator service.

Parameter

Type

Length

Required

Description

tdsChallengeInd

String

2

No

Indicates whether the challenge flow is required for the transaction.

01 = No preferences

02 = No challenge required

03 = Challenge required: 3DSRequestor Preference

04 = Challenge required: Required

This parameter will only be considered if the merchant has 3DS authentication enabled.

Parameter

Type

Description

PaymeInternalAction

Enum

SDK internal action indicator. It can have the following values

• PRESS_PAY_BUTTON: Indicates that the user pressed the pay button.

• START_SCORING: Rules evaluation process begins (RBA - Drools).

• END_SCORING: Finalize the rules evaluation process.

• START_TDS: Starts the 3DS authentication process.

• END_TDS: The 3DS authentication process is finished.

• START_AUTHORIZATION: Initiates authorization.

Parameter

Type

Length

Description

success

Boolean

-

It is true if the process was successful, false if an error occurred during payment processing.

resultCode

String

2

Processing result code.

resultMessage

String

30

Text describing the result of processing.

resultDetail

String

100

Additional details describing the result of the processing.

reserved

Diccionario

-

Contains the behavioral settings values for the reserved data coming from the trade.

payment

PaymentProcessResponse object

-

Result of the payment process as long as no error occurs in the transaction processing.

Parameter

Type

Length

Description

accepted

Boolean

-

It has value true when the payment has been processed correctly, false if it has been rejected for any reason at the time of the transaction.

operationNumber

String

6

Transaction number corresponding to the transaction.

operationDate

String

25

Transaction processing date. Example: 15/06/2023 11:30:49 +0000 (dd/MM/yyyy HH:mm:ss ZZZZ)

authorizationCode

String

10

Transaction identifier.

maskedPan

String

16

Masked card

brand

String

4

Card brand

installments

PaymentIntallmentsResponse object

-

Information on plans and installments

Parameter

Type

Length

Description

type

String

2

number

String

2

amount

String

11

Value of the installment

currencyCode

String

2

Currency

firstExpirationDate

String

10

Date of first installment due date